diff options
| author | Cem Keylan <cem@ckyln.com> | 2020-12-26 03:23:39 +0300 |
|---|---|---|
| committer | Cem Keylan <cem@ckyln.com> | 2020-12-26 03:23:39 +0300 |
| commit | 374252a55c14f92aaed73b3917ed783bf2762911 (patch) | |
| tree | 5117e1db656639a01d392da07cae6b1a2150cd55 | |
| parent | a25685ba1f185ad4c2bb858a8e2472dfc17d7c26 (diff) | |
| download | website-374252a55c14f92aaed73b3917ed783bf2762911.tar.gz | |
docs: update
180 files changed, 6448 insertions, 6497 deletions
@@ -125,10 +125,10 @@ main() { genrss index news index.html > src/news.xml genrss src/blog > src/rss.xml - # Generate htmldocs - command -v makeinfo && { - git submodule update --init --remote -f - make -s -C texidocs HTMLDIR="$PWD/src/docs" htmldocs + # Generate documentation + command -v emacs >/dev/null && command -v makeinfo >/dev/null && { + git submodule update --init --remote -f --recursive + HTMLDIR=$PWD/src/docs redo texidocs/htmldocs } # Generate pages diff --git a/docs/404.html b/docs/404.html index 00fe2f6..e8e1c19 100644 --- a/docs/404.html +++ b/docs/404.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200128.html b/docs/blog/20200128.html index 5ba2fa6..ff04471 100644 --- a/docs/blog/20200128.html +++ b/docs/blog/20200128.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200406.html b/docs/blog/20200406.html index 304d736..ce9d3f7 100644 --- a/docs/blog/20200406.html +++ b/docs/blog/20200406.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200410.html b/docs/blog/20200410.html index 7adf820..0cf1a46 100644 --- a/docs/blog/20200410.html +++ b/docs/blog/20200410.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200508.html b/docs/blog/20200508.html index b595847..9ca0eb4 100644 --- a/docs/blog/20200508.html +++ b/docs/blog/20200508.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200528.html b/docs/blog/20200528.html index cc283c4..c7b419d 100644 --- a/docs/blog/20200528.html +++ b/docs/blog/20200528.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200617.html b/docs/blog/20200617.html index d183262..63fe53f 100644 --- a/docs/blog/20200617.html +++ b/docs/blog/20200617.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20200803.html b/docs/blog/20200803.html index 7c5cb28..6ca2a18 100644 --- a/docs/blog/20200803.html +++ b/docs/blog/20200803.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/20201210.html b/docs/blog/20201210.html index 0b1d4e1..f6dc832 100644 --- a/docs/blog/20201210.html +++ b/docs/blog/20201210.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/blog/index.html b/docs/blog/index.html index 01bb642..19d24d1 100644 --- a/docs/blog/index.html +++ b/docs/blog/index.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/contributing.html b/docs/contributing.html index be9e00e..8cdbb67 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/docs.html b/docs/docs.html index 5f638d4..eeace4d 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/docs/0010.html b/docs/docs/0010.html index 495a177..fad5ef3 100644 --- a/docs/docs/0010.html +++ b/docs/docs/0010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0010"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0010"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0010">0010</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0010">0010</a>.</p> </body> diff --git a/docs/docs/0011.html b/docs/docs/0011.html index f1cc6bb..ab45257 100644 --- a/docs/docs/0011.html +++ b/docs/docs/0011.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0011"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0011"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0011">0011</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0011">0011</a>.</p> </body> diff --git a/docs/docs/0012.html b/docs/docs/0012.html index a53264a..32dca75 100644 --- a/docs/docs/0012.html +++ b/docs/docs/0012.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0012"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0012"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0012">0012</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0012">0012</a>.</p> </body> diff --git a/docs/docs/0013.html b/docs/docs/0013.html index 95fee3c..27102b1 100644 --- a/docs/docs/0013.html +++ b/docs/docs/0013.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0013"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0013"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0013">0013</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0013">0013</a>.</p> </body> diff --git a/docs/docs/1010.html b/docs/docs/1010.html index a202655..a9635e8 100644 --- a/docs/docs/1010.html +++ b/docs/docs/1010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1020.html b/docs/docs/1020.html index a5625c3..2f73bac 100644 --- a/docs/docs/1020.html +++ b/docs/docs/1020.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1030.html b/docs/docs/1030.html index a115463..bb51640 100644 --- a/docs/docs/1030.html +++ b/docs/docs/1030.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1040.html b/docs/docs/1040.html index 23b0de0..ae10d79 100644 --- a/docs/docs/1040.html +++ b/docs/docs/1040.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1041.html b/docs/docs/1041.html index 5e893c8..a75e629 100644 --- a/docs/docs/1041.html +++ b/docs/docs/1041.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1042.html b/docs/docs/1042.html index b2512eb..c9e5426 100644 --- a/docs/docs/1042.html +++ b/docs/docs/1042.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1043.html b/docs/docs/1043.html index 81f9202..32807ad 100644 --- a/docs/docs/1043.html +++ b/docs/docs/1043.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/1050.html b/docs/docs/1050.html index 514d9bf..c913527 100644 --- a/docs/docs/1050.html +++ b/docs/docs/1050.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2010.html b/docs/docs/2010.html index af89e0b..482ddf3 100644 --- a/docs/docs/2010.html +++ b/docs/docs/2010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2020.html b/docs/docs/2020.html index 62725ba..dab5be2 100644 --- a/docs/docs/2020.html +++ b/docs/docs/2020.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2030.html b/docs/docs/2030.html index d9da18e..353fd6f 100644 --- a/docs/docs/2030.html +++ b/docs/docs/2030.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2040.html b/docs/docs/2040.html index 166fefe..84e108a 100644 --- a/docs/docs/2040.html +++ b/docs/docs/2040.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2050.html b/docs/docs/2050.html index 51dc0b5..a8b2a70 100644 --- a/docs/docs/2050.html +++ b/docs/docs/2050.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2210.html b/docs/docs/2210.html index bf28d26..1304a27 100644 --- a/docs/docs/2210.html +++ b/docs/docs/2210.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2211.html b/docs/docs/2211.html index dc1e677..9d2f2b3 100644 --- a/docs/docs/2211.html +++ b/docs/docs/2211.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2212.html b/docs/docs/2212.html index f34310a..e14d231 100644 --- a/docs/docs/2212.html +++ b/docs/docs/2212.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2220.html b/docs/docs/2220.html index 3cabc62..4012c71 100644 --- a/docs/docs/2220.html +++ b/docs/docs/2220.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2230.html b/docs/docs/2230.html index c5fbbdd..b03a69c 100644 --- a/docs/docs/2230.html +++ b/docs/docs/2230.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2240.html b/docs/docs/2240.html index 5a2f9e0..c8e98f2 100644 --- a/docs/docs/2240.html +++ b/docs/docs/2240.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/2241.html b/docs/docs/2241.html index 80cdd37..dba5354 100644 --- a/docs/docs/2241.html +++ b/docs/docs/2241.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/cptroot.html b/docs/docs/ADDENDUM-How-to-use-this-License-for-your-documents.html index 3e9dfbe..b3423c8 100644 --- a/docs/docs/cptroot.html +++ b/docs/docs/ADDENDUM-How-to-use-this-License-for-your-documents.html @@ -7,15 +7,16 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cptroot (Carbs Linux User Manual)</title> +<title>ADDENDUM How to use this License for your documents (Carbs Linux User Manual)</title> -<meta name="description" content="cptroot (Carbs Linux User Manual)"> -<meta name="keywords" content="cptroot (Carbs Linux User Manual)"> +<meta name="description" content="ADDENDUM How to use this License for your documents (Carbs Linux User Manual)"> +<meta name="keywords" content="ADDENDUM How to use this License for your documents (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=Environment-Variables.html#cptroot"> +<meta http-equiv="Refresh" content="0; url=GNU-Free-Documentation-License.html#ADDENDUM-How-to-use-this-License-for-your-documents"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="Environment-Variables.html#cptroot">cptroot</a>.</p> +<p>The node you are looking for is at <a href="GNU-Free-Documentation-License.html#ADDENDUM-How-to-use-this-License-for-your-documents">ADDENDUM How to use this License for your documents</a>.</p> </body> diff --git a/src/docs/cpt_002dalternatives.html b/docs/docs/Bootloader.html index df24945..6f23a5b 100644 --- a/src/docs/cpt_002dalternatives.html +++ b/docs/docs/Bootloader.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-alternatives (Carbs Linux User Manual)</title> +<title>Bootloader (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-alternatives (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-alternatives (Carbs Linux User Manual)"> +<meta name="description" content="Bootloader (Carbs Linux User Manual)"> +<meta name="keywords" content="Bootloader (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dbuild.html" rel="next" title="cpt-build"> -<link href="Usage.html" rel="prev" title="Usage"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Init-scripts.html" rel="next" title="Init scripts"> +<link href="Making-your-system-bootable.html" rel="prev" title="Making your system bootable"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,44 +47,42 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dalternatives"></span><div class="header"> +<span id="Bootloader"></span><div class="header"> <p> -Next: <a href="cpt_002dbuild.html" accesskey="n" rel="next"><code>cpt-build</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Init-scripts.html" accesskey="n" rel="next">Init scripts</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dalternatives-1"></span><h4 class="subsection">2.1.1 <code>cpt-alternatives</code></h4> +<span id="Bootloader-1"></span><h4 class="subsection">1.5.1 Bootloader</h4> -<p>You can list and swap to alternatives using <code>cpt-alternatives</code>, or -<code>cpt a</code> for short. When run without alternatives, it will list -alternatives. It can read from standard input if <samp>-</samp> is given as an -argument. +<p>In the main repository, there is efibootmgr and grub to serve as bootloaders. +efibootmgr can be used as a standalone bootloader, or can be used to install +grub in a UEFI environment. efibootmgr is needed unless you are using a device +without UEFI support (or you really want to use BIOS for a reason). </p> +<ol> +<li> GRUB BIOS installation -<span id="Examples"></span><h4 class="unnumberedsubsubsec">Examples</h4> - -<p>List alternatives -</p> <div class="example"> -<pre class="example">$ cpt-alternatives -ncurses /usr/bin/clear -ncurses /usr/bin/reset +<pre class="example">cpt b grub && cpt i grub +grub-install --target=i386-pc /dev/sdX +grub-mkconfig -o /boot/grub/grub.cfg </pre></div> -<p>Swap to <code>clear</code> from <code>ncurses</code>. -</p> -<div class="example"> -<pre class="example">$ cpt-alternatives ncurses /usr/bin/clear --> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses' -</pre></div> +</li><li> GRUB UEFI installation + -<p>Swap in bulk (all of sbase). -</p> <div class="example"> -<pre class="example">$ cpt a | grep ^sbase | cpt a - -</pre></div> +<pre class="example">cpt b efibootmgr && cpt i efibootmgr +cpt b grub && cpt i grub +grub-install --target=x86_64-efi \ + --efi-directory=esp \ + --bootloader-id=CarbsLinux +grub-mkconfig -o /boot/grub/grub.cfg +</pre></div> +</li></ol> diff --git a/docs/docs/Building-the-kernel.html b/docs/docs/Building-the-kernel.html new file mode 100644 index 0000000..e0f5ee2 --- /dev/null +++ b/docs/docs/Building-the-kernel.html @@ -0,0 +1,72 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Building the kernel (Carbs Linux User Manual)</title> + +<meta name="description" content="Building the kernel (Carbs Linux User Manual)"> +<meta name="keywords" content="Building the kernel (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Making-your-system-bootable.html" rel="next" title="Making your system bootable"> +<link href="Kernel-dependencies.html" rel="prev" title="Kernel dependencies"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Building-the-kernel"></span><div class="header"> +<p> +Previous: <a href="Kernel-dependencies.html" accesskey="p" rel="prev">Kernel dependencies</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Building-the-kernel-1"></span><h4 class="subsection">1.4.3 Building the kernel</h4> + +<p>Next step is configuring and building the kernel. You can check Gentoo’s +<a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> to learn more about the matter. Overall, Gentoo Wiki +is a good place to learn about configuration according to your hardware. The +following will assume a monolithic kernel. +</p> +<div class="example"> +<pre class="example">make menuconfig +make +install -Dm755 $(make -s image_name) /boot/vmlinuz-linux +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/Changing-Init-Program.html b/docs/docs/Changing-Init-Program.html index 2948f40..d1cc7ce 100644 --- a/docs/docs/Changing-Init-Program.html +++ b/docs/docs/Changing-Init-Program.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Init-System.html" rel="up" title="Init System"> -<link href="Contribution-Guidelines.html" rel="next" title="Contribution Guidelines"> +<link href="Rebooting-after-changing-init.html" rel="next" title="Rebooting after changing init"> <link href="Init-Hooks.html" rel="prev" title="Init Hooks"> <style type="text/css"> <!-- @@ -48,57 +49,35 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Changing-Init-Program"></span><div class="header"> <p> -Previous: <a href="Init-Hooks.html" accesskey="p" rel="prev">Init Hooks</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="Configuring-Init.html" accesskey="p" rel="prev">Configuring Init</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Changing-Init-Program-1"></span><h3 class="section">3.3 Changing Init Program</h3> +<span id="Changing-Init-Program-1"></span><h3 class="section">2.2 Changing Init Program</h3> -<p>By default, Carbs Linux comes preinstalled with <code>busybox-init</code>, but this -can easily be replaced without any issues. Currently, available init systems are: +<p>By default, Carbs Linux comes preinstalled with ‘<samp>busybox-init</samp>’, but this can +easily be replaced without any issues. Currently, available init systems are: </p> <ul> -<li> sinit -</li><li> busybox -</li><li> runit -</li><li> shinit +<li> ‘<samp>sinit</samp>’ +</li><li> ‘<samp>busybox</samp>’ +</li><li> ‘<samp>runit</samp>’ +</li><li> ‘<samp>shinit</samp>’ </li></ul> <p>This example is for runit, but it will work with all init systems packaged in the -distribution repositories. See <a href="cpt_002dalternatives.html"><code>cpt-alternatives</code></a> +distribution repositories. See the ‘<samp>cpt-alternatives(1)</samp>’ manual page for more +details. </p> <div class="example"> -<pre class="example">$ cpt a runit /usr/bin/init -$ cpt a runit /usr/bin/poweroff -$ cpt a runit /usr/bin/reboot +<pre class="example">cpt a runit /usr/bin/init +cpt a runit /usr/bin/poweroff +cpt a runit /usr/bin/reboot </pre></div> - - -<span id="Rebooting-after-changing-Init"></span><h4 class="subsection">3.3.1 Rebooting after changing Init</h4> - -<p>After switching init systems, your running init system may not accept the -new poweroff commands. You will need to reboot/poweroff using the running init’s -utilities for the new utilities to work. These commands are for the init system -currently running on your system and not the one you are switching to. -</p> -<dl compact="compact"> -<dt><code>busybox</code></dt> -<dd><p><code>$ busybox reboot</code> -</p></dd> -<dt><code>runit</code></dt> -<dd><p><code>$ runit-init 6</code> -</p></dd> -<dt><code>shinit/sinit</code></dt> -<dd><p><code>$ kill -s INT 1</code> -</p></dd> -</dl> - - - - - - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Rebooting-after-changing-init.html" accesskey="1">Rebooting after changing init</a></td><td> </td><td align="left" valign="top">Ways to reboot after replacing the init system +</td></tr> +</table> diff --git a/docs/docs/Chroot.html b/docs/docs/Chroot.html index 6cfa061..c648361 100644 --- a/docs/docs/Chroot.html +++ b/docs/docs/Chroot.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="System-Configuration.html" rel="next" title="System Configuration"> -<link href="Preparing-Environment.html" rel="prev" title="Preparing Environment"> +<link href="Setting-up-repositories.html" rel="next" title="Setting up repositories"> +<link href="Obtain-the-chroot-helper.html" rel="prev" title="Obtain the chroot helper"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -56,178 +57,23 @@ Next: <a href="System-Configuration.html" accesskey="n" rel="next">System Config <p>Chroot into Carbs Linux! </p> <div class="example"> -<pre class="example">$ ./cpt-chroot /mnt +<pre class="example">./cpt-chroot /mnt </pre></div> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Setting-up-repositories.html" accesskey="1">Setting up repositories</a></td><td> </td><td align="left" valign="top">Basic setup for obtaining repositories +</td></tr> +<tr><td align="left" valign="top">• <a href="Updating-packages.html" accesskey="2">Updating packages</a></td><td> </td><td align="left" valign="top">Update your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Installing-packages.html" accesskey="3">Installing packages</a></td><td> </td><td align="left" valign="top">Install new software on your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Essential-Software.html" accesskey="4">Essential Software</a></td><td> </td><td align="left" valign="top">Software you might want to include on your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtaining-the-documentation.html" accesskey="5">Obtaining the documentation</a></td><td> </td><td align="left" valign="top">Install documentation for offline use (optional) +</td></tr> +</table> -<span id="Setting-up-repositories"></span><h4 class="subsection">1.2.1 Setting up repositories</h4> - -<p>Newest tarballs do not come with repositories, so you will need to manually -obtain them, and set your <code>CPT_PATH</code> environment variable. Carbs Linux -repositories can either be obtained by <code>git</code> or <code>rsync</code>. -While rsync repositories are overall faster and smaller, git offers the whole -history of the repository and a means to manipulate your repository as you like -it. If you want to obtain the git repository, you will need to install -<code>git</code> itself. -</p> -<p>The following guide will assume that you put the repositories into -<samp>~/repos/</samp> directory, but you can put the repositories into any directory -you want. So go ahead and create that directory: -</p> -<div class="example"> -<pre class="example">$ mkdir -p $HOME/repos -</pre></div> - - - -<span id="Obtaining-from-rsync"></span><h4 class="subsubsection">1.2.1.1 Obtaining from rsync</h4> - -<p>Carbs Linux rsync repositories live in <a href="rsync://carbslinux.org/repo">rsync://carbslinux.org/repo</a>. In -order to obtain it, run the following: -</p> -<div class="example"> -<pre class="example">$ rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs -</pre></div> - - - -<span id="Obtaining-from-git"></span><h4 class="subsubsection">1.2.1.2 Obtaining from git</h4> - -<p>Carbs Linux git repositories can be found both from the main server and GitHub -(mirror). Here are both their repository links. You can clone any of them. -</p> -<ul> -<li> <a href="git://git.carbslinux.org/repository">git://git.carbslinux.org/repository</a> -</li><li> <a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a> -</li></ul> - -<div class="example"> -<pre class="example">$ git clone git://git.carbslinux.org/repository $HOME/repos/carbs -</pre></div> - - - -<span id="Making-the-package-manager-use-the-repositories"></span><h4 class="subsubsection">1.2.1.3 Making the package manager use the repositories</h4> - -<p>In your shell’s configuration file, or in your <samp>~/.profile</samp> file, add the -following lines: -</p> -<div class="example"> -<pre class="example">export CPT_PATH='' -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/core -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community -export CPT_PATH -</pre></div> - - - -<span id="Updating-packages"></span><h4 class="subsection">1.2.2 Updating packages</h4> - -<p>It is good practice to make sure your system is up to date, especially before -building new packages. If there is an update for the package manager you will -need to update twice. -</p> -<div class="example"> -<pre class="example">$ cpt update -</pre></div> - - - -<span id="Installing-packages"></span><h4 class="subsection">1.2.3 Installing packages</h4> - -<p>Since you are operating on a really small base, you might need to build and -install new programs to extend the functionality of your system. In order to -build and install packages new packages in Carbs, you need to execute the -following. “Package” is not actually a package and is given as an example. -</p> -<div class="example"> -<pre class="example">$ cpt build package -$ cpt install package -</pre></div> - - - -<span id="Essential-Software"></span><h4 class="subsection">1.2.4 Essential Software</h4> - -<p>Here is a list of software that you might want to have on your system. -</p> -<p>BOOTLOADERS -</p><ul> -<li> efibootmgr -</li><li> grub -</li></ul> -<p>FILESYSTEMS -</p><ul> -<li> e2fsprogs -</li><li> dosfstools -</li><li> ntfs-3g -</li></ul> -<p>NETWORKING -</p><ul> -<li> dhcpcd -</li><li> wpa_supplicant -</li></ul> -<p>TEXT EDITORS -</p><ul> -<li> nano -</li><li> vim -</li><li> neatvi -</li><li> nvi -</li><li> emacs -</li><li> emacs-nox (terminal-only version of emacs) -</li></ul> -<p>USER SHELLS -</p><ul> -<li> bash -</li><li> zsh -</li><li> dash -</li><li> oksh -</li><li> rc -</li></ul> -<p>POSIX BASE UTILITIES -</p><ul> -<li> busybox -</li><li> sbase -</li><li> coreutils -</li></ul> -<p>DOCUMENTATION -</p><ul> -<li> carbs-docs -</li><li> man-pages -</li><li> man-pages-posix -</li></ul> - - - -<span id="Obtaining-the-documentation-_0028optional_0029"></span><h4 class="subsection">1.2.5 Obtaining the documentation (optional)</h4> - -<p>All the documentation for Carbs Linux can be found on a single info manual to be -viewed offline. You can obtain texinfo or the info (standalone) package in order -to view the documentation. -</p> -<div class="example"> -<pre class="example">Install the documentation. -$ cpt b carbs-docs && cpt i carbs-docs - -Install either texinfo or the info package. We will be installing standalone info -as it doesn't need perl. -$ cpt b info && cpt i info - -You can then run info and navigate through the documentation. -$ info carbslinux -</pre></div> - - - -<hr> -<div class="header"> -<p> -Next: <a href="System-Configuration.html" accesskey="n" rel="next">System Configuration</a>, Previous: <a href="Preparing-Environment.html" accesskey="p" rel="prev">Preparing Environment</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/docs/docs/Configuring-Init.html b/docs/docs/Configuring-Init.html index eddc1ac..93f7f35 100644 --- a/docs/docs/Configuring-Init.html +++ b/docs/docs/Configuring-Init.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Init-System.html" rel="up" title="Init System"> -<link href="Init-Hooks.html" rel="next" title="Init Hooks"> +<link href="Kernel-Command-Line.html" rel="next" title="Kernel Command Line"> <link href="Init-System.html" rel="prev" title="Init System"> <style type="text/css"> <!-- @@ -48,56 +49,27 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Configuring-Init"></span><div class="header"> <p> -Next: <a href="Init-Hooks.html" accesskey="n" rel="next">Init Hooks</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Changing-Init-Program.html" accesskey="n" rel="next">Changing Init Program</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Configuring-Init-1"></span><h3 class="section">3.1 Configuring Init</h3> +<span id="Configuring-Init-1"></span><h3 class="section">2.1 Configuring Init</h3> <p>There are three ways you can change the behaviour of the init system. Those are: </p> -<ol> +<ul> <li> Kernel Command Line -</li><li> <samp>/etc/init/rc.conf</samp> file +</li><li> ‘<samp>/etc/init/rc.conf</samp>’ file </li><li> Init Hooks -</li></ol> - - - -<span id="Kernel-Command-Line"></span><h4 class="subsection">3.1.1 Kernel Command Line</h4> - -<p>On GRUB, you can edit the kernel command line parameters, which will be parsed -as variables on the init system. Not all of the parameters will be acted upon, -but all of them will be set as variables on the init script. For example an -example command line, and how it is interpreted. -</p> -<div class="example"> -<pre class="example">BOOT_IMAGE=/boot/vmlinuz root=/dev/sda2 rw loglevel=3 quiet -</pre></div> - -<p>This command line will be parsed to set the following variables: -</p> -<div class="example"> -<pre class="example">BOOT_IMAGE=/boot/vmlinuz -root=/dev/sda2 -rw=1 -loglevel=3 -quiet=1 -</pre></div> - -<p>Some of these variables, such as <code>rw</code>/<code>ro</code>, <code>loglevel</code>, and -<code>quiet</code>, will be used by the init system to change the behaviour of the -startup. -</p> - - -<span id="g_t_002fetc_002finit_002frc_002econf-file"></span><h4 class="subsection">3.1.2 <samp>/etc/init/rc.conf</samp> file</h4> - -<p>However, the kernel command line isn’t the only place to set your boot -parameters. You can specify variables here as well, although note that the -kernel command line always gets the priority for these variables since they can -be set just before boot. -</p> - +</li></ul> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Kernel-Command-Line.html" accesskey="1">Kernel Command Line</a></td><td> </td><td align="left" valign="top">Configure init through the boot parameters +</td></tr> +<tr><td align="left" valign="top">• <a href="_002fetc_002finit_002frcconf-file.html" accesskey="2">‘<samp>/etc/init/rc.conf</samp>’ file</a></td><td> </td><td align="left" valign="top">Configure init through the configuration file +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-Hooks.html" accesskey="3">Init Hooks</a></td><td> </td><td align="left" valign="top">Configure init through hooks +</td></tr> +</table> diff --git a/docs/docs/cpt_002ddownload.html b/docs/docs/Configuring-hostname.html index 2eb2a3d..f4d4bee 100644 --- a/docs/docs/cpt_002ddownload.html +++ b/docs/docs/Configuring-hostname.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-download (Carbs Linux User Manual)</title> +<title>Configuring hostname (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-download (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-download (Carbs Linux User Manual)"> +<meta name="description" content="Configuring hostname (Carbs Linux User Manual)"> +<meta name="keywords" content="Configuring hostname (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dfetch.html" rel="next" title="cpt-fetch"> -<link href="cpt_002dchecksum.html" rel="prev" title="cpt-checksum"> +<link href="System-Configuration.html" rel="up" title="System Configuration"> +<link href="Hosts-file.html" rel="next" title="Hosts file"> +<link href="System-Configuration.html" rel="prev" title="System Configuration"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,16 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002ddownload"></span><div class="header"> +<span id="Configuring-hostname"></span><div class="header"> <p> -Next: <a href="cpt_002dfetch.html" accesskey="n" rel="next"><code>cpt-fetch</code></a>, Previous: <a href="cpt_002dchecksum.html" accesskey="p" rel="prev"><code>cpt-checksum</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Hosts-file.html" accesskey="n" rel="next">Hosts file</a>, Up: <a href="System-Configuration.html" accesskey="u" rel="up">System Configuration</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002ddownload-1"></span><h4 class="subsection">2.1.4 <code>cpt-download</code></h4> +<span id="Configuring-hostname-1"></span><h4 class="subsection">1.3.1 Configuring hostname</h4> -<p><code>cpt-download</code> will download the sources of a package. +<p>You might want to add a hostname, especially in a networked environment. Your +hostname will default to ’carbslinux’ unless you set this. </p> - +<div class="example"> +<pre class="example">echo your-hostname > /etc/hostname +</pre></div> diff --git a/docs/docs/Contribution-Guidelines.html b/docs/docs/Contribution-Guidelines.html index cbb7b02..5b2c7cf 100644 --- a/docs/docs/Contribution-Guidelines.html +++ b/docs/docs/Contribution-Guidelines.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> <link href="Conventions.html" rel="next" title="Conventions"> -<link href="Changing-Init-Program.html" rel="prev" title="Changing Init Program"> +<link href="Rebooting-after-changing-init.html" rel="prev" title="Rebooting after changing init"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -51,23 +52,19 @@ ul.no-bullet {list-style: none} Next: <a href="GNU-Free-Documentation-License.html" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="Init-System.html" accesskey="p" rel="prev">Init System</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Contribution-Guidelines-1"></span><h2 class="chapter">4 Contribution Guidelines</h2> +<span id="Contribution-Guidelines-1"></span><h2 class="chapter">3 Contribution Guidelines</h2> <p>Thanks for taking your time to contribute! To maintain stylistic behaviour throughout the repositories, one must adhere to these conventions. Exceptions and changes may occur with good reasoning. </p> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Conventions.html" accesskey="1">Conventions</a></td><td> </td><td align="left" valign="top">Distribution conventions -</td></tr> -<tr><td align="left" valign="top">• <a href="Sending-Git-mails.html" accesskey="2">Sending Git mails</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Conventions.html" accesskey="1">Conventions</a></td><td> </td><td align="left" valign="top">Conventions of the distribution </td></tr> </table> - - </body> </html> diff --git a/docs/docs/Conventions.html b/docs/docs/Conventions.html index 362292a..e1b3ac6 100644 --- a/docs/docs/Conventions.html +++ b/docs/docs/Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> -<link href="General-Conventions.html" rel="next" title="General Conventions"> +<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> <link href="Contribution-Guidelines.html" rel="prev" title="Contribution Guidelines"> <style type="text/css"> <!-- @@ -48,24 +49,48 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Conventions"></span><div class="header"> <p> -Next: <a href="Sending-Git-mails.html" accesskey="n" rel="next">Sending Git mails</a>, Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Conventions-1"></span><h3 class="section">4.1 Conventions</h3> +<span id="Conventions-1"></span><h3 class="section">3.1 Conventions</h3> + + + +<dl compact="compact"> +<dt>[<span id="g_t0010"></span>0010]</dt> +<dd><p>Try to keep the file readable. +</p><dl compact="compact"> +<dt>[<span id="g_t0011"></span>0011]</dt> +<dd><p>Characters on a line shouldn’t exceed 100 characters. +</p></dd> +<dt>[<span id="g_t0012"></span>0012]</dt> +<dd><p>Make sure you don’t have code commented out during +commit. Uncomment them or remove them completely. +</p></dd> +<dt>[<span id="g_t0013"></span>0013]</dt> +<dd><p>Do not add comments following the code, add them to the +top of the code. It makes it harder to read, and lines longer. Here is an example: +</p></dd> +</dl> + +<div class="example"> +<pre class="example"># Good way of commenting. +your code goes here + +your code goes here # Avoid this way of commenting. +</pre></div> +</dd> +</dl> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="General-Conventions.html" accesskey="1">General Conventions</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="2">Shell Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="1">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts </td></tr> -<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="3">Repository Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="2">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts </td></tr> </table> - - </body> </html> diff --git a/src/docs/cpt_002dlist.html b/docs/docs/Download.html index d31b5e2..5d2a595 100644 --- a/src/docs/cpt_002dlist.html +++ b/docs/docs/Download.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-list (Carbs Linux User Manual)</title> +<title>Download (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-list (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-list (Carbs Linux User Manual)"> +<meta name="description" content="Download (Carbs Linux User Manual)"> +<meta name="keywords" content="Download (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dremove.html" rel="next" title="cpt-remove"> -<link href="cpt_002dinstall.html" rel="prev" title="cpt-install"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Signature-verification.html" rel="next" title="Signature verification"> +<link href="Preparing-Environment.html" rel="prev" title="Preparing Environment"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,20 +47,22 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dlist"></span><div class="header"> +<span id="Download"></span><div class="header"> <p> -Next: <a href="cpt_002dremove.html" accesskey="n" rel="next"><code>cpt-remove</code></a>, Previous: <a href="cpt_002dinstall.html" accesskey="p" rel="prev"><code>cpt-install</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Signature-verification.html" accesskey="n" rel="next">Signature verification</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dlist-1"></span><h4 class="subsection">2.1.7 <code>cpt-list</code></h4> +<span id="Download-1"></span><h4 class="subsection">1.1.1 Download</h4> -<p>When called without arguments, <code>cpt-list</code> will print all installed -packages. You can add package names as arguments to check whether they are -installed or not. In success, <code>cpt-list</code> will exit with status 0 if all -given packages are installed, it will return 1 if any of the given packages -aren’t installed. +<p>First, we need to download the rootfs tarball. You can do the following in order +to obtain the rootfs. If you are using an i686 machine, replace the ‘<samp>x86_64</samp>’ +with ‘<samp>i686</samp>’. We are setting this in a URL variable so that we don’t have to +write it every time. </p> - +<div class="example"> +<pre class="example">wget $URL/carbs-rootfs.tar.xz.sha256 +sha256sum -c carbs-rootfs.tar.xz.sha256 +</pre></div> diff --git a/docs/docs/Editing-the-build-file-during-pre_002dbuild.html b/docs/docs/Editing-the-build-file-during-pre_002dbuild.html deleted file mode 100644 index 7955ddb..0000000 --- a/docs/docs/Editing-the-build-file-during-pre_002dbuild.html +++ /dev/null @@ -1,93 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Editing the build file during pre-build (Carbs Linux User Manual)</title> - -<meta name="description" content="Editing the build file during pre-build (Carbs Linux User Manual)"> -<meta name="keywords" content="Editing the build file during pre-build (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Hooks.html" rel="up" title="Hooks"> -<link href="Packaging-System.html" rel="next" title="Packaging System"> -<link href="Hooks.html" rel="prev" title="Hooks"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Editing-the-build-file-during-pre_002dbuild"></span><div class="header"> -<p> -Up: <a href="Hooks.html" accesskey="u" rel="up">Hooks</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Editing-the-build-file-during-pre_002dbuild-1"></span><h4 class="subsection">2.3.1 Editing the <samp>build</samp> file during pre-build</h4> - -<p>You can edit the <samp>build</samp> file during pre-build. The file is copied from the -repository to the build directory named as <samp>.build.cpt</samp>. You can use -<code>sed</code> or any other tool to edit the build file. After the build is -complete, a <code>diff</code> file will be placed to the package database named as -<samp>build.diff</samp>. Here is an example <samp>build</samp> file manipulation during the -pre-build hook. -</p> -<div class="example"> -<pre class="example">cat <<EOF> .build.cpt -#!/bin/sh -e - -for patch in bash50-0??; do - patch -p0 < "\$patch" -done - -export LDFLAGS=-static - -./configure \ - --prefix=/usr \ - --without-bash-malloc \ - --disable-nls - -export MAKEFLAGS="TERMCAP_LIB=/usr/lib/libncursesw.a $MAKEFLAGS" - -make -make DESTDIR="\$1" install - -ln -s bash "\$1/usr/bin/sh" -EOF -</pre></div> - - - - - - -</body> -</html> diff --git a/docs/docs/Environment-Variables.html b/docs/docs/Environment-Variables.html deleted file mode 100644 index b47dfd6..0000000 --- a/docs/docs/Environment-Variables.html +++ /dev/null @@ -1,184 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Environment Variables (Carbs Linux User Manual)</title> - -<meta name="description" content="Environment Variables (Carbs Linux User Manual)"> -<meta name="keywords" content="Environment Variables (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Hooks.html" rel="next" title="Hooks"> -<link href="cpt_002dupdate.html" rel="prev" title="cpt-update"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Environment-Variables"></span><div class="header"> -<p> -Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Environment-Variables-1"></span><h3 class="section">2.2 Environment Variables</h3> - -<p>Since there is no configuration file for cpt, the package manager is configured -through environment variables. These can be set per operation, or be set to your -shell configuration or <samp>~/.profile</samp>. Here are the environment variables that -alter the behaviour of <code>cpt</code>: -</p> -<dl compact="compact"> -<dt><code>CPT_PATH</code></dt> -<dd><p>Set the locations of your repositories. This is set similar to the <code>PATH</code> -variable. -</p> -</dd> -<dt><code>XDG_CACHE_HOME</code></dt> -<dd><p>Unless this is set, the <samp>~/.cache</samp> directory will be used instead. -</p> -</dd> -<dt><code>CPT_CACHE</code></dt> -<dd><p>The cache directory for <code>cpt</code>. Default: <samp>$XDG_CACHE_HOME/cpt</samp> -</p> -</dd> -<dt><code>CPT_CHOICE</code></dt> -<dd><p>If this is set to 0, a package installation will be aborted on conflicts. -Default: 1 -</p> -</dd> -<dt><code>CPT_COMPRESS</code></dt> -<dd><p>Program used to compress package tarballs. The values should be the default -suffixes for the program. Available values are: -</p> -<ul> -<li> <code>gz</code> -</li><li> <code>zst</code> -</li><li> <code>bz2</code> -</li><li> <code>xz</code> -</li></ul> -<p>Default: <code>gz</code> -</p> -</dd> -<dt><code>CPT_DEBUG</code></dt> -<dd><p>If this is set to 1, temporary build directories will not be removed after the -given operation. Default: unset -</p> -</dd> -<dt><code>CPT_FETCH</code></dt> -<dd><p>If this is set to 0, <code>cpt-update</code> will not fetch the repositories. -This behaviour can also be achieved by adding <samp>-n</samp> or <samp>--no-fetch</samp> -as an argument. Default: 0 -</p> -</dd> -<dt><code><span id="cptforce"></span>CPT_FORCE</code></dt> -<dd><p>If this is set to 1, some of the <code>cpt</code> tools will continue regardless of -errors or skip certain checks. Here are some examples: -</p> -<ul> -<li> <code>cpt-install</code> will install a package without verifying its manifest. -</li><li> <code>cpt-install</code> will install a package even when there are missing -dependencies. -</li><li> <code>cpt-remove</code> will remove packages even when there are other packages -that depend on the current package. -</li></ul> - -<p>This behaviour can also be achieved by adding <samp>-f</samp> or <samp>--force</samp> -as an argument to those utilities. -</p> -<p>Default: 0 -</p> -</dd> -<dt><code>CPT_HOOK</code></dt> -<dd><p>Location for the hook file See <a href="Hooks.html">Hooks</a>. Default: unset -</p> -</dd> -<dt><code>CPT_KEEPLOG</code></dt> -<dd><p>Normally, logs are deleted if the package is built successfully. If set to 1, -logs will be kept even when the packages are built as intended. Default: 0 -</p> -</dd> -<dt><code>CPT_PID</code></dt> -<dd><p>If this variable is set, the temporary files will be created with this variable -as the suffix, instead of the PID of the <code>cpt</code> process. The advantage -is that you can know exactly where the build directory is located, while the -disadvantage is that there will be issues with multiple operations at the -same time. So the best way to use this variable is during one-time <code>cpt</code> -calls. -</p> -<div class="example"> -<pre class="example">CPT_PID=mesa cpt b mesa -</pre></div> - -<p>By running the above, you will know that the created build directories will end -with the <tt>*-mesa</tt> suffix. -</p> -</dd> -<dt><code>CPT_PROMPT</code></dt> -<dd><p>If set to 0, the package manager will not prompt you for anything and will -continue with the default action. This behaviour can also be achieved by adding <samp>-y</samp> or <samp>--no-prompt</samp> -as an argument to some utilities. -Default: 1 -</p> -</dd> -<dt><code><span id="cptroot"></span>CPT_ROOT</code></dt> -<dd><p>If this variable is set, <code>cpt</code> will assume this as the system root, and -will install/remove/update/list packages assuming this is the system root. -This behaviour can also be achieved by adding <samp>--root</samp> as an argument to some utilities. -</p> -</dd> -<dt><code>CPT_TEST</code></dt> -<dd><p>If set to 1, <code>cpt-build</code> will run tests where a package has the -<samp>test</samp> build file. This behaviour can also be achieved by adding <samp>-t</samp> or <samp>--test</samp> -as an argument to <code>cpt-build</code>. Default: 0 -</p> -</dd> -<dt><code>CPT_TMPDIR</code></dt> -<dd><p>The directory to create the build files. This can be changed (for example to -/tmp) for building on RAM, saving SSD space, etc. Default: <code>$CPT_CACHE</code> -</p> -</dd> -</dl> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/docs/docs/Essential-Software.html b/docs/docs/Essential-Software.html new file mode 100644 index 0000000..3910e9b --- /dev/null +++ b/docs/docs/Essential-Software.html @@ -0,0 +1,120 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Essential Software (Carbs Linux User Manual)</title> + +<meta name="description" content="Essential Software (Carbs Linux User Manual)"> +<meta name="keywords" content="Essential Software (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Obtaining-the-documentation.html" rel="next" title="Obtaining the documentation"> +<link href="Installing-packages.html" rel="prev" title="Installing packages"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Essential-Software"></span><div class="header"> +<p> +Next: <a href="Obtaining-the-documentation.html" accesskey="n" rel="next">Obtaining the documentation</a>, Previous: <a href="Installing-packages.html" accesskey="p" rel="prev">Installing packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Essential-Software-1"></span><h4 class="subsection">1.2.4 Essential Software</h4> + +<p>Here is a list of software that you might want to have on your system. +</p> +<p><strong>BOOTLOADERS</strong> +</p> +<ul> +<li> efibootmgr +</li><li> grub +</li></ul> + +<p><strong>FILESYSTEMS</strong> +</p> +<ul> +<li> e2fsprogs +</li><li> dosfstools +</li><li> ntfs-3g +</li></ul> + +<p><strong>NETWORKING</strong> +</p> +<ul> +<li> dhcpcd +</li><li> wpa<em>_supplicant</em> +</li></ul> + +<p><strong>TEXT EDITORS</strong> +</p> +<ul> +<li> nano +</li><li> vim +</li><li> neatvi +</li><li> emacs +</li><li> emacs-nox (terminal-only version of emacs) +</li></ul> + +<p><strong>USER SHELLS</strong> +</p> +<ul> +<li> bash +</li><li> zsh +</li><li> oksh +</li><li> rc +</li></ul> + +<p><strong>POSIX BASE UTILITIES</strong> +</p> +<ul> +<li> busybox +</li><li> sbase +</li><li> coreutils +</li></ul> + +<p><strong>DOCUMENTATION</strong> +</p> +<ul> +<li> carbs-docs +</li><li> man-pages +</li><li> man-pages-posix +</li></ul> + + + + +</body> +</html> diff --git a/docs/docs/Extracting-the-tarball.html b/docs/docs/Extracting-the-tarball.html new file mode 100644 index 0000000..8659608 --- /dev/null +++ b/docs/docs/Extracting-the-tarball.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Extracting the tarball (Carbs Linux User Manual)</title> + +<meta name="description" content="Extracting the tarball (Carbs Linux User Manual)"> +<meta name="keywords" content="Extracting the tarball (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Obtain-the-chroot-helper.html" rel="next" title="Obtain the chroot helper"> +<link href="Signature-verification.html" rel="prev" title="Signature verification"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Extracting-the-tarball"></span><div class="header"> +<p> +Next: <a href="Obtain-the-chroot-helper.html" accesskey="n" rel="next">Obtain the chroot helper</a>, Previous: <a href="Signature-verification.html" accesskey="p" rel="prev">Signature verification</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Extracting-the-tarball-1"></span><h4 class="subsection">1.1.3 Extracting the tarball</h4> + +<p>You will need to extract the tarball to your desired location. For partitioning, +you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. This will assume that you will be mounting your root +partition to ‘<samp>/mnt</samp>’. +</p> +<div class="example"> +<pre class="example">mount /dev/sdx1 /mnt +tar xf carbs-rootfs.tar.xz -C /mnt +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/cpt_002dchecksum.html b/docs/docs/Fstab.html index 8a038be..d4573ec 100644 --- a/docs/docs/cpt_002dchecksum.html +++ b/docs/docs/Fstab.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-checksum (Carbs Linux User Manual)</title> +<title>Fstab (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-checksum (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-checksum (Carbs Linux User Manual)"> +<meta name="description" content="Fstab (Carbs Linux User Manual)"> +<meta name="keywords" content="Fstab (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002ddownload.html" rel="next" title="cpt-download"> -<link href="cpt_002dbuild.html" rel="prev" title="cpt-build"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Post_002dinstallation.html" rel="next" title="Post-installation"> +<link href="Init-scripts.html" rel="prev" title="Init scripts"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,17 +47,21 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dchecksum"></span><div class="header"> +<span id="Fstab"></span><div class="header"> <p> -Next: <a href="cpt_002ddownload.html" accesskey="n" rel="next"><code>cpt-download</code></a>, Previous: <a href="cpt_002dbuild.html" accesskey="p" rel="prev"><code>cpt-build</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="Init-scripts.html" accesskey="p" rel="prev">Init scripts</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dchecksum-1"></span><h4 class="subsection">2.1.3 <code>cpt-checksum</code></h4> +<span id="Fstab-1"></span><h4 class="subsection">1.5.3 Fstab</h4> -<p><code>cpt-checksum</code> will generate a <samp>checksums</samp> file from the package’s -sources. +<p>You can now manually edit your fstab entry, or you can use the genfstab tool. +If you want to use the tool, exit the chroot and run the following: </p> - +<div class="example"> +<pre class="example">wget https://github.com/cemkeylan/genfstab/raw/master/genfstab +chmod +x genfstab +./genfstab -U /mnt >> /mnt/etc/fstab +</pre></div> diff --git a/docs/docs/GNU-Free-Documentation-License.html b/docs/docs/GNU-Free-Documentation-License.html index 9b9be9d..4fb6747 100644 --- a/docs/docs/GNU-Free-Documentation-License.html +++ b/docs/docs/GNU-Free-Documentation-License.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> -<link href="Sending-Git-mails.html" rel="prev" title="Sending Git mails"> +<link href="Repository-Conventions.html" rel="prev" title="Repository Conventions"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -50,14 +51,13 @@ ul.no-bullet {list-style: none} Previous: <a href="Contribution-Guidelines.html" accesskey="p" rel="prev">Contribution Guidelines</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="GNU-Free-Documentation-License-1"></span><h2 class="unnumbered">GNU Free Documentation License</h2> +<span id="GNU-Free-Documentation-License-1"></span><h2 class="appendix">Appendix A GNU Free Documentation License</h2> <div align="center">Version 1.3, 3 November 2008 </div> - <div class="display"> <pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -<a href="https://fsf.org/">https://fsf.org/</a> +<a href="http://fsf.org/">http://fsf.org/</a> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -67,190 +67,197 @@ of this license document, but changing it is not allowed. <li> PREAMBLE <p>The purpose of this License is to make a manual, textbook, or other -functional and useful document <em>free</em> in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. -</p> -<p>This License is a kind of “copyleft”, which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft +functional and useful document <em>free</em> +in the sense of freedom: to assure everyone the effective freedom +to copy and redistribute it, with or without modifying it, either +commercially or noncommercially. Secondarily, this License +preserves for the author and publisher a way to get credit for +their work, while not being considered responsible for +modifications made by others. +</p> +<p>This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. +It complements the GNU General Public License, which is a copyleft license designed for free software. </p> -<p>We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. +<p>We have designed this License in order to use it for manuals for +free software, because free software needs free documentation: +a free program should come with manuals providing the same freedoms +that the software does. But this License is not limited to +software manuals; it can be used for any textual work, regardless +of subject matter or whether it is published as a printed book. We +recommend this License principally for works whose purpose is +instruction or reference. </p> </li><li> APPLICABILITY AND DEFINITIONS -<p>This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The “Document”, below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as “you”. You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. -</p> -<p>A “Modified Version” of the Document means any work containing the +<p>This License applies to any manual or other work, in any medium, +that contains a notice placed by the copyright holder saying it can +be distributed under the terms of this License. Such a notice +grants a world-wide, royalty-free license, unlimited in duration, +to use that work under the conditions stated herein. The +"Document", below, refers to any such manual or work. Any member +of the public is a licensee, and is addressed as "you". You accept +the license if you copy, modify or distribute the work in a way +requiring permission under copyright law. +</p> +<p>A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. </p> -<p>A “Secondary Section” is a named appendix or a front-matter section +<p>A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. -</p> -<p>The “Invariant Sections” are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. -</p> -<p>The “Cover Texts” are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. -</p> -<p>A “Transparent” copy of the Document means a machine-readable copy, +subject (or to related matters) and contains nothing that could +fall directly within that overall subject. (Thus, if the Document +is in part a textbook of mathematics, a Secondary Section may not +explain any mathematics.) The relationship could be a matter of +historical connection with the subject or with related matters, or +of legal, commercial, philosophical, ethical or political position +regarding them. +</p> +<p>The "Invariant Sections" are certain Secondary Sections whose +titles are designated, as being those of Invariant Sections, in the +notice that says that the Document is released under this License. +If a section does not fit the above definition of Secondary then it +is not allowed to be designated as Invariant. The Document may +contain zero Invariant Sections. If the Document does not identify +any Invariant Sections then there are none. +</p> +<p>The "Cover Texts" are certain short passages of text that are +listed, as Front-Cover Texts or Back-Cover Texts, in the notice +that says that the Document is released under this License. +A Front-Cover Text may be at most 5 words, and a Back-Cover Text +may be at most 25 words. +</p> +<p>A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not “Transparent” is called “Opaque”. +straightforwardly with generic text editors or (for images composed +of pixels) generic paint programs or (for drawings) some widely +available drawing editor, and that is suitable for input to text +formatters or for automatic translation to a variety of formats +suitable for input to text formatters. A copy made in an otherwise +Transparent file format whose markup, or absence of markup, has +been arranged to thwart or discourage subsequent modification by +readers is not Transparent. An image format is not Transparent if +used for any substantial amount of text. A copy that is not +"Transparent" is called "Opaque". </p> <p>Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input -format, SGML or XML using a publicly available -DTD, and standard-conforming simple HTML, -PostScript or PDF designed for human modification. Examples -of transparent image formats include PNG, XCF and -JPG. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, SGML or -XML for which the DTD and/or processing tools are -not generally available, and the machine-generated HTML, -PostScript or PDF produced by some word processors for -output purposes only. -</p> -<p>The “Title Page” means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, “Title Page” means -the text near the most prominent appearance of the work’s title, -preceding the beginning of the body of the text. -</p> -<p>The “publisher” means any person or entity that distributes copies +ASCII without markup, Texinfo input format, LaTeX input format, +SGML or XML using a publicly available DTD, and standard-conforming +simple HTML, PostScript or PDF designed for human modification. +Examples of transparent image formats include PNG, XCF and JPG. +Opaque formats include proprietary formats that can be read and +edited only by proprietary word processors, SGML or XML for which +the DTD and/or processing tools are not generally available, and +the machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. +</p> +<p>The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the +material this License requires to appear in the title page. For +works in formats which do not have any title page as such, "Title +Page" means the text near the most prominent appearance of the +work’s title, preceding the beginning of the body of the text. +</p> +<p>The "publisher" means any person or entity that distributes copies of the Document to the public. </p> -<p>A section “Entitled XYZ” means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as “Acknowledgements”, -“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” -of such a section when you modify the Document means that it remains a -section “Entitled XYZ” according to this definition. -</p> -<p>The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. +<p>A section "Entitled XYZ" means a named subunit of the Document +whose title either is precisely XYZ or contains XYZ in parentheses +following text that translates XYZ in another language. (Here XYZ +stands for a specific section name mentioned below, such as +"Acknowledgements", "Dedications", "Endorsements", or "History".) +To "Preserve the Title" of such a section when you modify the +Document means that it remains a section "Entitled XYZ" according +to this definition. +</p> +<p>The Document may include Warranty Disclaimers next to the notice +which states that this License applies to the Document. These +Warranty Disclaimers are considered to be included by reference in +this License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and +has no effect on the meaning of this License. </p> </li><li> VERBATIM COPYING <p>You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. -</p> -<p>You may also lend copies, under the same conditions stated above, and -you may publicly display copies. +copyright notices, and the license notice saying this License +applies to the Document are reproduced in all copies, and that you +add no other conditions whatsoever to those of this License. You +may not use technical measures to obstruct or control the reading +or further copying of the copies you make or distribute. However, +you may accept compensation in exchange for copies. If you +distribute a large enough number of copies you must also follow the +conditions in section 3. +</p> +<p>You may also lend copies, under the same conditions stated above, +and you may publicly display copies. </p> </li><li> COPYING IN QUANTITY -<p>If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document’s license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. +<p>If you publish printed copies (or copies in media that commonly +have printed covers) of the Document, numbering more than 100, and +the Document’s license notice requires Cover Texts, you must +enclose the copies in covers that carry, clearly and legibly, all +these Cover Texts: Front-Cover Texts on the front cover, and +Back-Cover Texts on the back cover. Both covers must also clearly +and legibly identify you as the publisher of these copies. The +front cover must present the full title with all words of the title +equally prominent and visible. You may add other material on the +covers in addition. Copying with changes limited to the covers, as +long as they preserve the title of the Document and satisfy these +conditions, can be treated as verbatim copying in other respects. </p> <p>If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. -</p> -<p>If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. -</p> -<p>It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. +reasonably) on the actual cover, and continue the rest onto +adjacent pages. +</p> +<p>If you publish or distribute Opaque copies of the Document +numbering more than 100, you must either include a machine-readable +Transparent copy along with each Opaque copy, or state in or with +each Opaque copy a computer-network location from which the general +network-using public has access to download using public-standard +network protocols a complete Transparent copy of the Document, free +of added material. If you use the latter option, you must take +reasonably prudent steps, when you begin distribution of Opaque +copies in quantity, to ensure that this Transparent copy will +remain thus accessible at the stated location until at least one +year after the last time you distribute an Opaque copy (directly or +through your agents or retailers) of that edition to the public. +</p> +<p>It is requested, but not required, that you contact the authors of +the Document well before redistributing any large number of copies, +to give them a chance to provide you with an updated version of the +Document. </p> </li><li> MODIFICATIONS -<p>You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: +<p>You may copy and distribute a Modified Version of the Document +under the conditions of sections 2 and 3 above, provided that you +release the Modified Version under precisely this License, with the +Modified Version filling the role of the Document, thus licensing +distribution and modification of the Modified Version to whoever +possesses a copy of it. In addition, you must do these things in +the Modified Version: </p> <ol type="A" start="1"> -<li> Use in the Title Page (and on the covers, if any) a title distinct -from that of the Document, and from those of previous versions -(which should, if there were any, be listed in the History section -of the Document). You may use the same title as a previous version -if the original publisher of that version gives permission. - -</li><li> List on the Title Page, as authors, one or more persons or entities -responsible for authorship of the modifications in the Modified -Version, together with at least five of the principal authors of the -Document (all of its principal authors, if it has fewer than five), -unless they release you from this requirement. +<li> Use in the Title Page (and on the covers, if any) a title +distinct from that of the Document, and from those of previous +versions (which should, if there were any, be listed in the +History section of the Document). You may use the same title as +a previous version if the original publisher of that version +gives permission. + +</li><li> List on the Title Page, as authors, one or more persons or +entities responsible for authorship of the modifications in the +Modified Version, together with at least five of the principal +authors of the Document (all of its principal authors, if it has +fewer than five), unless they release you from this requirement. </li><li> State on the Title page the name of the publisher of the Modified Version, as the publisher. @@ -260,45 +267,50 @@ Modified Version, as the publisher. </li><li> Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. -</li><li> Include, immediately after the copyright notices, a license notice -giving the public permission to use the Modified Version under the -terms of this License, in the form shown in the Addendum below. +</li><li> Include, immediately after the copyright notices, a license +notice giving the public permission to use the Modified Version +under the terms of this License, in the form shown in the +Addendum below. -</li><li> Preserve in that license notice the full lists of Invariant Sections -and required Cover Texts given in the Document’s license notice. +</li><li> Preserve in that license notice the full lists of Invariant +Sections and required Cover Texts given in the Document’s +license notice. </li><li> Include an unaltered copy of this License. -</li><li> Preserve the section Entitled “History”, Preserve its Title, and add -to it an item stating at least the title, year, new authors, and -publisher of the Modified Version as given on the Title Page. If -there is no section Entitled “History” in the Document, create one -stating the title, year, authors, and publisher of the Document as -given on its Title Page, then add an item describing the Modified -Version as stated in the previous sentence. - -</li><li> Preserve the network location, if any, given in the Document for -public access to a Transparent copy of the Document, and likewise -the network locations given in the Document for previous versions -it was based on. These may be placed in the “History” section. -You may omit a network location for a work that was published at -least four years before the Document itself, or if the original -publisher of the version it refers to gives permission. - -</li><li> For any section Entitled “Acknowledgements” or “Dedications”, Preserve -the Title of the section, and preserve in the section all the -substance and tone of each of the contributor acknowledgements and/or -dedications given therein. - -</li><li> Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers -or the equivalent are not considered part of the section titles. - -</li><li> Delete any section Entitled “Endorsements”. Such a section -may not be included in the Modified Version. - -</li><li> Do not retitle any existing section to be Entitled “Endorsements” or -to conflict in title with any Invariant Section. +</li><li> Preserve the section Entitled "History", Preserve its Title, and +add to it an item stating at least the title, year, new authors, +and publisher of the Modified Version as given on the Title +Page. If there is no section Entitled "History" in the Document, +create one stating the title, year, authors, and publisher of +the Document as given on its Title Page, then add an item +describing the Modified Version as stated in the previous +sentence. + +</li><li> Preserve the network location, if any, given in the Document +for public access to a Transparent copy of the Document, and +likewise the network locations given in the Document for +previous versions it was based on. These may be placed in the +"History" section. You may omit a network location for a work +that was published at least four years before the Document +itself, or if the original publisher of the version it refers +to gives permission. + +</li><li> For any section Entitled "Acknowledgements" or "Dedications", +Preserve the Title of the section, and preserve in the section +all the substance and tone of each of the contributor +acknowledgements and/or dedications given therein. + +</li><li> Preserve all the Invariant Sections of the Document, unaltered +in their text and in their titles. Section numbers or the +equivalent are not considered part of the section titles. + +</li><li> Delete any section Entitled "Endorsements". Such a section may +not be included in the Modified Version. + +</li><li> Do not retitle any existing section to be Entitled +"Endorsements" or to conflict in title with any Invariant +Section. </li><li> Preserve any Warranty Disclaimers. </li></ol> @@ -310,7 +322,7 @@ of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles. </p> -<p>You may add a section Entitled “Endorsements”, provided it contains +<p>You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a @@ -332,182 +344,188 @@ imply endorsement of any Modified Version. </p> </li><li> COMBINING DOCUMENTS -<p>You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. +<p>You may combine the Document with other documents released under +this License, under the terms defined in section 4 above for +modified versions, provided that you include in the combination all +of the Invariant Sections of all of the original documents, +unmodified, and list them all as Invariant Sections of your +combined work in its license notice, and that you preserve all +their Warranty Disclaimers. </p> <p>The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. -</p> -<p>In the combination, you must combine any sections Entitled “History” -in the various original documents, forming one section Entitled -“History”; likewise combine any sections Entitled “Acknowledgements”, -and any sections Entitled “Dedications”. You must delete all -sections Entitled “Endorsements.” +copy. If there are multiple Invariant Sections with the same name +but different contents, make the title of each such section unique +by adding at the end of it, in parentheses, the name of the +original author or publisher of that section if known, or else +a unique number. Make the same adjustment to the section titles in +the list of Invariant Sections in the license notice of the +combined work. +</p> +<p>In the combination, you must combine any sections Entitled +"History" in the various original documents, forming one section +Entitled "History"; likewise combine any sections Entitled +"Acknowledgements", and any sections Entitled "Dedications". You +must delete all sections Entitled "Endorsements." </p> </li><li> COLLECTIONS OF DOCUMENTS -<p>You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. +<p>You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the +rules of this License for verbatim copying of each of the documents +in all other respects. </p> -<p>You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. +<p>You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert +a copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. </p> </li><li> AGGREGATION WITH INDEPENDENT WORKS -<p>A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an “aggregate” if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation’s users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. +<p>A compilation of the Document or its derivatives with other +separate and independent documents or works, in or on a volume of +a storage or distribution medium, is called an "aggregate" if the +copyright resulting from the compilation is not used to limit the +legal rights of the compilation’s users beyond what the individual +works permit. When the Document is included in an aggregate, this +License does not apply to the other works in the aggregate which +are not themselves derivative works of the Document. </p> <p>If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document’s Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. +copies of the Document, then if the Document is less than one half +of the entire aggregate, the Document’s Cover Texts may be placed +on covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic +form. Otherwise they must appear on printed covers that bracket +the whole aggregate. </p> </li><li> TRANSLATION <p>Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. -</p> -<p>If a section in the Document is Entitled “Acknowledgements”, -“Dedications”, or “History”, the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. +distribute translations of the Document under the terms of +section 4. Replacing Invariant Sections with translations requires +special permission from their copyright holders, but you may +include translations of some or all Invariant Sections in addition +to the original versions of these Invariant Sections. You may +include a translation of this License, and all the license notices +in the Document, and any Warranty Disclaimers, provided that you +also include the original English version of this License and the +original versions of those notices and disclaimers. In case of +a disagreement between the translation and the original version of +this License or a notice or disclaimer, the original version will +prevail. +</p> +<p>If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to +Preserve its Title (section 1) will typically require changing the +actual title. </p> </li><li> TERMINATION <p>You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. +otherwise to copy, modify, sublicense, or distribute it is void, +and will automatically terminate your rights under this License. </p> -<p>However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. +<p>However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the +copyright holder fails to notify you of the violation by some +reasonable means prior to 60 days after the cessation. </p> <p>Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. +received notice of violation of this License (for any work) from +that copyright holder, and you cure the violation prior to 30 days +after your receipt of the notice. </p> -<p>Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. +<p>Termination of your rights under this section does not terminate +the licenses of parties who have received copies or rights from you +under this License. If your rights have been terminated and not +permanently reinstated, receipt of a copy of some or all of the +same material does not give you any rights to use it. </p> </li><li> FUTURE REVISIONS OF THIS LICENSE -<p>The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new +<p>The Free Software Foundation may publish new, revised versions of +the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See -<a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>. -</p> -<p>Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License “or any later version” applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy’s public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. +<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>. +</p> +<p>Each version of the License is given a distinguishing version +number. If the Document specifies that a particular numbered +version of this License "or any later version" applies to it, you +have the option of following the terms and conditions either of +that specified version or of any later version that has been +published (not as a draft) by the Free Software Foundation. If +the Document does not specify a version number of this License, +you may choose any version ever published (not as a draft) by the +Free Software Foundation. If the Document specifies that a proxy +can decide which future versions of this License can be used, that +proxy’s public statement of acceptance of a version permanently +authorizes you to choose that version for the Document. </p> </li><li> RELICENSING -<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +<p>"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -“Massive Multiauthor Collaboration” (or “MMC”) contained in the -site means any set of copyrightable works thus published on the MMC -site. -</p> -<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. -</p> -<p>“Incorporate” means to publish or republish a Document, in whole or -in part, as part of another Document. -</p> -<p>An MMC is “eligible for relicensing” if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole -or in part into the MMC, (1) had no cover texts or invariant sections, -and (2) were thus incorporated prior to November 1, 2008. -</p> -<p>The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. +provides prominent facilities for anybody to edit those works. +A public wiki that anybody can edit is an example of such +a server. A "Massive Multiauthor Collaboration" (or "MMC") +contained in the site means any set of copyrightable works thus +published on the MMC site. </p> -</li></ol> +<p>"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, +a not-for-profit corporation with a principal place of business in +San Francisco, California, as well as future copyleft versions of +that license published by that same organization. +</p> +<p>"Incorporate" means to publish or republish a Document, in whole +or in part, as part of another Document. +</p> +<p>An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this +License somewhere other than this MMC, and subsequently +incorporated in whole or in part into the MMC, (1) had no cover +texts or invariant sections, and (2) were thus incorporated prior +to November 1, 2008. +</p> +<p>The operator of an MMC Site may republish an MMC contained in the +site under CC-BY-SA on the same site at any time before August 1, +2009, provided the MMC is eligible for relicensing. +</p></li></ol> + -<span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="heading">ADDENDUM: How to use this License for your documents</h3> +<span id="ADDENDUM-How-to-use-this-License-for-your-documents"></span><span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="appendixsec">A.1 ADDENDUM: How to use this License for your documents</h3> <p>To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: </p> <div class="example"> -<pre class="example"> Copyright (C) <var>year</var> <var>your name</var>. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. +<pre class="example">Copyright (C) YEAR YOUR NAME. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 +or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover +Texts. A copy of the license is included in the section entitled ``GNU +Free Documentation License''. </pre></div> <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the “with…Texts.” line with this: +replace the "with…Texts." line with this: </p> <div class="example"> -<pre class="example"> with the Invariant Sections being <var>list their titles</var>, with - the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts - being <var>list</var>. +<pre class="example">with the Invariant Sections being LIST THEIR TITLES, with +the Front-Cover Texts being LIST, and with the Back-Cover Texts +being LIST. </pre></div> <p>If you have Invariant Sections without Cover Texts, or some other @@ -516,12 +534,9 @@ situation. </p> <p>If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. +free software license, such as the GNU General Public License, to +permit their use in free software. </p> - - - <hr> <div class="header"> <p> diff --git a/docs/docs/General-Conventions.html b/docs/docs/General-Conventions.html deleted file mode 100644 index e3591dc..0000000 --- a/docs/docs/General-Conventions.html +++ /dev/null @@ -1,87 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>General Conventions (Carbs Linux User Manual)</title> - -<meta name="description" content="General Conventions (Carbs Linux User Manual)"> -<meta name="keywords" content="General Conventions (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Conventions.html" rel="up" title="Conventions"> -<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> -<link href="Conventions.html" rel="prev" title="Conventions"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="General-Conventions"></span><div class="header"> -<p> -Next: <a href="Shell-Conventions.html" accesskey="n" rel="next">Shell Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="General-Conventions-_002d_002d-00"></span><h4 class="subsection">4.1.1 General Conventions – 00</h4> - -<dl compact="compact"> -<dt><strong>[<span id="g_t0010"></span>0010]</strong></dt> -<dd><p>Try to keep the file readable. -</p><dl compact="compact"> -<dt><strong>[<span id="g_t0011"></span>0011]</strong></dt> -<dd><p>Characters on a line shouldn’t exceed 100 characters. -</p></dd> -<dt><strong>[<span id="g_t0012"></span>0012]</strong></dt> -<dd><p>Make sure you don’t have code commented out during commit. Uncomment them -or remove them completely. -</p></dd> -<dt><strong>[<span id="g_t0013"></span>0013]</strong></dt> -<dd><p>Do not add comments following the code, add them to the top of the code. It -makes it harder to read, and lines longer. Here is an example: -</p><div class="example"> -<pre class="example"># Good way of commenting. -your code goes here - -your code goes here # Avoid this way of commenting. -</pre></div> -</dd> -</dl> -</dd> -</dl> - - - - - - -</body> -</html> diff --git a/docs/docs/Hooks.html b/docs/docs/Hooks.html deleted file mode 100644 index e78cbf9..0000000 --- a/docs/docs/Hooks.html +++ /dev/null @@ -1,103 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Hooks (Carbs Linux User Manual)</title> - -<meta name="description" content="Hooks (Carbs Linux User Manual)"> -<meta name="keywords" content="Hooks (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Editing-the-build-file-during-pre_002dbuild.html" rel="next" title="Editing the build file during pre-build"> -<link href="Environment-Variables.html" rel="prev" title="Environment Variables"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Hooks"></span><div class="header"> -<p> -Next: <a href="Packaging-System.html" accesskey="n" rel="next">Packaging System</a>, Previous: <a href="Environment-Variables.html" accesskey="p" rel="prev">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Hooks-1"></span><h3 class="section">2.3 Hooks</h3> - -<p>Hooks can be used in order to change the runtime behaviour of the package manager. -There are a variety of package hooks, mostly self explanatory: -</p> -<ul> -<li> pre-build -</li><li> post-build -</li><li> build-fail -</li><li> pre-test -</li><li> test-fail -</li><li> pre-install -</li><li> post-install -</li><li> pre-remove -</li><li> post-remove -</li><li> pre-fetch -</li><li> post-fetch -</li><li> post-package -</li></ul> - -<p>In order to use hooks, you will need to set the <code>CPT_HOOK</code> variable pointing -to your hook file. Your hook file <strong>MUST</strong> be a POSIX shell script as its -contents are sourced by the package manager. -</p> -<p>The hook is given 3 variables when it is executed. Those are: -</p><dl compact="compact"> -<dt><code>$TYPE</code></dt> -<dd><p>The type of the hook, (pre-build, post-build, etc.) -</p></dd> -<dt><code>$PKG</code></dt> -<dd><p>The package that <code>cpt</code> is currently working on. Can be null. -</p></dd> -<dt><code>$DEST</code></dt> -<dd><p>The destination of the operation. Can be null. -</p></dd> -</dl> - - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Editing-the-build-file-during-pre_002dbuild.html" accesskey="1">Editing the <samp>build</samp> file during pre-build</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/docs/docs/Hosts-file.html b/docs/docs/Hosts-file.html new file mode 100644 index 0000000..ed26d62 --- /dev/null +++ b/docs/docs/Hosts-file.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Hosts file (Carbs Linux User Manual)</title> + +<meta name="description" content="Hosts file (Carbs Linux User Manual)"> +<meta name="keywords" content="Hosts file (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="System-Configuration.html" rel="up" title="System Configuration"> +<link href="Kernel.html" rel="next" title="Kernel"> +<link href="Configuring-hostname.html" rel="prev" title="Configuring hostname"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Hosts-file"></span><div class="header"> +<p> +Previous: <a href="Configuring-hostname.html" accesskey="p" rel="prev">Configuring hostname</a>, Up: <a href="System-Configuration.html" accesskey="u" rel="up">System Configuration</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Hosts-file-1"></span><h4 class="subsection">1.3.2 Hosts file</h4> + +<p>You can edit your /etc/hosts file, which is the static lookup table for host +names. By default, there are two entries for localhost which are OKAY. You can +replace the ’localhost’ part of these entries to your hostname. +</p> +<div class="example"> +<pre class="example">127.0.0.1 localhost.localdomain localhost +::1 localhost.localdomain localhost ip6-localhost +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/Init-Hooks.html b/docs/docs/Init-Hooks.html index a5a767d..52e2e84 100644 --- a/docs/docs/Init-Hooks.html +++ b/docs/docs/Init-Hooks.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -20,9 +21,9 @@ Documentation License." --> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Init-System.html" rel="up" title="Init System"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> <link href="Changing-Init-Program.html" rel="next" title="Changing Init Program"> -<link href="Configuring-Init.html" rel="prev" title="Configuring Init"> +<link href="_002fetc_002finit_002frcconf-file.html" rel="prev" title="/etc/init/rcconf file"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,28 +49,31 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Init-Hooks"></span><div class="header"> <p> -Next: <a href="Changing-Init-Program.html" accesskey="n" rel="next">Changing Init Program</a>, Previous: <a href="Configuring-Init.html" accesskey="p" rel="prev">Configuring Init</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="_002fetc_002finit_002frcconf-file.html" accesskey="p" rel="prev">‘<samp>/etc/init/rcconf</samp>’ file</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Init-Hooks-1"></span><h3 class="section">3.2 Init Hooks</h3> +<span id="Init-Hooks-1"></span><h4 class="subsection">2.1.3 Init Hooks</h4> <p>Init hooks are for custom personal commands that the user may want to add to alter their boot. These can be used to load kernel modules, modify interfaces, -and lot more. Those hooks are added to the <samp>/etc/init</samp> directory with the +and lot more. Those hooks are added to the ‘<samp>/etc/init</samp>’ directory with the hook name as the suffix. For example, a boot script will be placed as -<samp>/etc/init/my-hook.boot</samp>. Currently, there are 4 hooks that the user can use. +‘<samp>/etc/init/my-hook.boot</samp>’. Currently, there are 4 hooks that the user can use. </p> <dl compact="compact"> -<dt><samp>early-boot</samp></dt> +<dt>early-boot</dt> <dd><p>Run after pseudo-filesystems are mounted. </p></dd> -<dt><samp>boot</samp></dt> +<dt>boot</dt> <dd><p>Run before the boot stage is completed. </p></dd> -<dt><samp>pre.shutdown</samp></dt> +<dt>pre.shutdown</dt> <dd><p>Run first when shutting down. </p></dd> -<dt><samp>post.shutdown</samp></dt> +<dt>umount</dt> +<dd><p>Run just before filesystems are unmounted. +</p></dd> +<dt>post.shutdown</dt> <dd><p>Run just before the system is halted. </p></dd> </dl> @@ -77,7 +81,5 @@ hook name as the suffix. For example, a boot script will be placed as - - </body> </html> diff --git a/docs/docs/Init-System.html b/docs/docs/Init-System.html index fac32cd..3d23ab0 100644 --- a/docs/docs/Init-System.html +++ b/docs/docs/Init-System.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> <link href="Configuring-Init.html" rel="next" title="Configuring Init"> -<link href="Setting-up-an-rsync-repository-for-distribution.html" rel="prev" title="Setting up an rsync repository for distribution"> +<link href="KISS-repositories.html" rel="prev" title="KISS repositories"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,29 +49,25 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Init-System"></span><div class="header"> <p> -Next: <a href="Contribution-Guidelines.html" accesskey="n" rel="next">Contribution Guidelines</a>, Previous: <a href="Package-Manager.html" accesskey="p" rel="prev">Package Manager</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Contribution-Guidelines.html" accesskey="n" rel="next">Contribution Guidelines</a>, Previous: <a href="Installation.html" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Init-System-1"></span><h2 class="chapter">3 Init System</h2> +<span id="Init-System-1"></span><h2 class="chapter">2 Init System</h2> -<p>Carbs Linux init scripts are run by the init daemon (<code>busybox</code> by default) -on boot and shutdown processes. It also provides its own halting program named +<p>Carbs Linux init scripts are run by the init daemon (‘<samp>busybox</samp>’ by default) on +boot and shutdown processes. It also provides its own halting program named shalt. This provides a portable method that doesn’t rely on non-POSIX external programs. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="Configuring-Init.html" accesskey="1">Configuring Init</a></td><td> </td><td align="left" valign="top">Ways to configure the init system </td></tr> -<tr><td align="left" valign="top">• <a href="Init-Hooks.html" accesskey="2">Init Hooks</a></td><td> </td><td align="left" valign="top">Adding your personal commands to the init system -</td></tr> -<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html" accesskey="3">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replacing the default busybox init with something new +<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html" accesskey="2">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replace the default busybox init with something new </td></tr> </table> - - </body> </html> diff --git a/src/docs/cpt_002dsearch.html b/docs/docs/Init-scripts.html index 289903f..bd5a32a 100644 --- a/src/docs/cpt_002dsearch.html +++ b/docs/docs/Init-scripts.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-search (Carbs Linux User Manual)</title> +<title>Init scripts (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-search (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-search (Carbs Linux User Manual)"> +<meta name="description" content="Init scripts (Carbs Linux User Manual)"> +<meta name="keywords" content="Init scripts (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dupdate.html" rel="next" title="cpt-update"> -<link href="cpt_002dremove.html" rel="prev" title="cpt-remove"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Fstab.html" rel="next" title="Fstab"> +<link href="Bootloader.html" rel="prev" title="Bootloader"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,26 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dsearch"></span><div class="header"> +<span id="Init-scripts"></span><div class="header"> <p> -Next: <a href="cpt_002dupdate.html" accesskey="n" rel="next"><code>cpt-update</code></a>, Previous: <a href="cpt_002dremove.html" accesskey="p" rel="prev"><code>cpt-remove</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Fstab.html" accesskey="n" rel="next">Fstab</a>, Previous: <a href="Bootloader.html" accesskey="p" rel="prev">Bootloader</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dsearch-1"></span><h4 class="subsection">2.1.9 <code>cpt-search</code></h4> +<span id="Init-scripts-1"></span><h4 class="subsection">1.5.2 Init scripts</h4> -<p><code>cpt-search</code> will remove given packages. +<p>Only thing left to do is installing the init-scripts, and now you are almost +ready to boot your system! </p> - - -<span id="Options-3"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-s --single</samp></dt> -<dd><p>Only show the first instance of a package. -</p></dd> -</dl> - - +<div class="example"> +<pre class="example">cpt b carbs-init && cpt i carbs-init +</pre></div> diff --git a/docs/docs/Installation.html b/docs/docs/Installation.html index 7116e8c..a85f8f4 100644 --- a/docs/docs/Installation.html +++ b/docs/docs/Installation.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -48,35 +49,32 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Installation"></span><div class="header"> <p> -Next: <a href="Package-Manager.html" accesskey="n" rel="next">Package Manager</a>, Previous: <a href="index.html" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previous: <a href="index.html" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> <span id="Installation-1"></span><h2 class="chapter">1 Installation</h2> -<p>These are the step-by-step instructions for installing Carbs Linux. -</p> -<p>The instructions can also be found plaintext on -<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a> +<p>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 +<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a>. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="1">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot </td></tr> <tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="2">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system </td></tr> -<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="3">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing for your personal use +<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="3">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing your system for personal use </td></tr> <tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="4">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="5">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing init and bootloader +<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="5">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing bootloader and boot scripts </td></tr> -<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html" accesskey="6">Post-installation</a></td><td> </td><td align="left" valign="top">Acquiring more packages and repositories +<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html" accesskey="6">Post-installation</a></td><td> </td><td align="left" valign="top">Post-installation tasks </td></tr> </table> - - </body> </html> diff --git a/docs/docs/Installing-packages.html b/docs/docs/Installing-packages.html new file mode 100644 index 0000000..2a2e342 --- /dev/null +++ b/docs/docs/Installing-packages.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Installing packages (Carbs Linux User Manual)</title> + +<meta name="description" content="Installing packages (Carbs Linux User Manual)"> +<meta name="keywords" content="Installing packages (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Essential-Software.html" rel="next" title="Essential Software"> +<link href="Updating-packages.html" rel="prev" title="Updating packages"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Installing-packages"></span><div class="header"> +<p> +Next: <a href="Essential-Software.html" accesskey="n" rel="next">Essential Software</a>, Previous: <a href="Updating-packages.html" accesskey="p" rel="prev">Updating packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Installing-packages-1"></span><h4 class="subsection">1.2.3 Installing packages</h4> + +<p>Since you are operating on a really small base, you might need to build and +install new programs to extend the functionality of your system. In order to +build and install packages new packages in Carbs, you need to execute the +following. "Package" is not actually a package and is given as an example. +</p> +<div class="example"> +<pre class="example">cpt-build package +cpt-install package +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/cpt_002ddownload.html b/docs/docs/KISS-repositories.html index 2eb2a3d..3824e9e 100644 --- a/src/docs/cpt_002ddownload.html +++ b/docs/docs/KISS-repositories.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-download (Carbs Linux User Manual)</title> +<title>KISS repositories (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-download (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-download (Carbs Linux User Manual)"> +<meta name="description" content="KISS repositories (Carbs Linux User Manual)"> +<meta name="keywords" content="KISS repositories (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dfetch.html" rel="next" title="cpt-fetch"> -<link href="cpt_002dchecksum.html" rel="prev" title="cpt-checksum"> +<link href="Post_002dinstallation.html" rel="up" title="Post-installation"> +<link href="Init-System.html" rel="next" title="Init System"> +<link href="Post_002dinstallation.html" rel="prev" title="Post-installation"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,19 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002ddownload"></span><div class="header"> +<span id="KISS-repositories"></span><div class="header"> <p> -Next: <a href="cpt_002dfetch.html" accesskey="n" rel="next"><code>cpt-fetch</code></a>, Previous: <a href="cpt_002dchecksum.html" accesskey="p" rel="prev"><code>cpt-checksum</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Up: <a href="Post_002dinstallation.html" accesskey="u" rel="up">Post-installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002ddownload-1"></span><h4 class="subsection">2.1.4 <code>cpt-download</code></h4> +<span id="KISS-repositories-1"></span><h4 class="subsection">1.6.1 KISS repositories</h4> -<p><code>cpt-download</code> will download the sources of a package. +<p>While not 100% compatible with cpt, you can use kiss repositories in your +system the same way you are using the distribution repositories. Here is an +example for the KISS Linux Community repository. </p> - - </body> </html> diff --git a/docs/docs/Kernel-Command-Line.html b/docs/docs/Kernel-Command-Line.html new file mode 100644 index 0000000..a099dc8 --- /dev/null +++ b/docs/docs/Kernel-Command-Line.html @@ -0,0 +1,83 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Kernel Command Line (Carbs Linux User Manual)</title> + +<meta name="description" content="Kernel Command Line (Carbs Linux User Manual)"> +<meta name="keywords" content="Kernel Command Line (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> +<link href="_002fetc_002finit_002frcconf-file.html" rel="next" title="/etc/init/rcconf file"> +<link href="Configuring-Init.html" rel="prev" title="Configuring Init"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Kernel-Command-Line"></span><div class="header"> +<p> +Next: <a href="_002fetc_002finit_002frcconf-file.html" accesskey="n" rel="next">‘<samp>/etc/init/rcconf</samp>’ file</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Kernel-Command-Line-1"></span><h4 class="subsection">2.1.1 Kernel Command Line</h4> + +<p>On GRUB, you can edit the kernel command line parameters, which will be parsed +as variables on the init system. Not all of the parameters will be acted upon, +but all of them will be set as variables on the init script. For example an +example command line, and how it is interpreted. +</p> +<div class="example"> +<pre class="example">BOOT_IMAGE=/boot/vmlinuz root=/dev/sda2 rw loglevel=3 quiet +</pre></div> + +<p>This command line will be parsed to set the following variables: +</p> +<div class="example"> +<pre class="example">BOOT_IMAGE=/boot/vmlinuz +root=/dev/sda2 +rw=1 +loglevel=3 +quiet=1 +</pre></div> + +<p>Some of these variables, such as ‘<samp>rw=/=ro</samp>’, ‘<samp>loglevel</samp>’, and ‘<samp>quiet</samp>’, will be +used by the init system to change the behaviour of the startup. +</p> + + + +</body> +</html> diff --git a/docs/docs/Kernel-dependencies.html b/docs/docs/Kernel-dependencies.html new file mode 100644 index 0000000..192479b --- /dev/null +++ b/docs/docs/Kernel-dependencies.html @@ -0,0 +1,81 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Kernel dependencies (Carbs Linux User Manual)</title> + +<meta name="description" content="Kernel dependencies (Carbs Linux User Manual)"> +<meta name="keywords" content="Kernel dependencies (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Building-the-kernel.html" rel="next" title="Building the kernel"> +<link href="Obtaining-the-kernel-sources.html" rel="prev" title="Obtaining the kernel sources"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Kernel-dependencies"></span><div class="header"> +<p> +Next: <a href="Building-the-kernel.html" accesskey="n" rel="next">Building the kernel</a>, Previous: <a href="Obtaining-the-kernel-sources.html" accesskey="p" rel="prev">Obtaining the kernel sources</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Kernel-dependencies-1"></span><h4 class="subsection">1.4.2 Kernel dependencies</h4> + +<p>In order to compile the kernel you will need to install some dependencies. You +will need ‘<samp>libelf</samp>’ to compile the kernel. If you want to configure using the +menu interface you will also need ‘<samp>ncurses</samp>’. +</p> +<div class="example"> +<pre class="example"># The package manager asks to install if you are building more than one package, +# so no need to run 'cpt i ...' +cpt b libelf ncurses +</pre></div> + +<p>In the vanilla kernel sources, you need perl to compile the kernel, but it can +be easily patched out. You will need to apply the following patch. Patch was +written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and apply the patch in the kernel +source directory. +</p> +<div class="example"> +<pre class="example">wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch +patch -p1 < kernel-no-perl.patch +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/Kernel.html b/docs/docs/Kernel.html index 5f3eb9d..10f3945 100644 --- a/docs/docs/Kernel.html +++ b/docs/docs/Kernel.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Making-your-system-bootable.html" rel="next" title="Making your system bootable"> -<link href="System-Configuration.html" rel="prev" title="System Configuration"> +<link href="Obtaining-the-kernel-sources.html" rel="next" title="Obtaining the kernel sources"> +<link href="Hosts-file.html" rel="prev" title="Hosts file"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -54,74 +55,19 @@ Next: <a href="Making-your-system-bootable.html" accesskey="n" rel="next">Making <span id="Kernel-1"></span><h3 class="section">1.4 Kernel</h3> <p>Kernel isn’t managed under the main repositories, even though you could package -one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, -which you will need to reconfigure for your specific setup if you want to make -use of it. +one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, which you will +need to reconfigure for your specific setup if you want to make use of it. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Obtaining-the-kernel-sources.html" accesskey="1">Obtaining the kernel sources</a></td><td> </td><td align="left" valign="top">Downloading the Linux source code +</td></tr> +<tr><td align="left" valign="top">• <a href="Kernel-dependencies.html" accesskey="2">Kernel dependencies</a></td><td> </td><td align="left" valign="top">Requirements for building the kernel +</td></tr> +<tr><td align="left" valign="top">• <a href="Building-the-kernel.html" accesskey="3">Building the kernel</a></td><td> </td><td align="left" valign="top">Configure and compile the kernel +</td></tr> +</table> -<span id="Obtaining-the-kernel-sources"></span><h4 class="subsection">1.4.1 Obtaining the kernel sources</h4> - -<p>You can visit the https://kernel.org website to choose a kernel that you want -to install. Though only the latest stable and longterm (LTS) versions are -supported. -</p> -<div class="example"> -<pre class="example">Download the kernel and extract it -$ wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz -$ tar xf linux-5.7.6.tar.xz - -Change directory into the kernel sources -$ cd linux-5.7.6 -</pre></div> - - - -<span id="Installing-dependencies"></span><h4 class="subsection">1.4.2 Installing dependencies</h4> - -<p>In order to compile the kernel you will need to install some dependencies. You -will need <code>libelf</code> to compile the kernel. If you want to configure using the menu -interface you will also need <code>ncurses</code>. -</p> -<div class="example"> -<pre class="example">The package manager asks to install if you are building more than one package, -so no need to run 'cpt i ...' -$ cpt b libelf ncurses -</pre></div> - -<p>In the vanilla kernel sources, you need perl to compile the kernel, but it can -be easily patched out. You will need to apply the following patch. Patch was -written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and -apply the patch in the kernel source directory. -</p> -<div class="example"> -<pre class="example">$ wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch -$ patch -p1 < kernel-no-perl.patch -</pre></div> - - - -<span id="Compiling-the-kernel"></span><h4 class="subsection">1.4.3 Compiling the kernel</h4> - -<p>Next step is configuring and building the kernel. You can check Gentoo’s <a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> -to learn more about the matter. Overall, Gentoo Wiki is a good place to learn -about configuration according to your hardware. The following will assume a -monolithic kernel. -</p> -<div class="example"> -<pre class="example">$ make menuconfig -$ make -$ install -Dm755 $(make -s image_name) /boot/vmlinuz-linux -</pre></div> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Making-your-system-bootable.html" accesskey="n" rel="next">Making your system bootable</a>, Previous: <a href="System-Configuration.html" accesskey="p" rel="prev">System Configuration</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/docs/docs/Making-your-system-bootable.html b/docs/docs/Making-your-system-bootable.html index 58714a3..2e3a759 100644 --- a/docs/docs/Making-your-system-bootable.html +++ b/docs/docs/Making-your-system-bootable.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Post_002dinstallation.html" rel="next" title="Post-installation"> -<link href="Kernel.html" rel="prev" title="Kernel"> +<link href="Bootloader.html" rel="next" title="Bootloader"> +<link href="Building-the-kernel.html" rel="prev" title="Building the kernel"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -57,61 +58,14 @@ Next: <a href="Post_002dinstallation.html" accesskey="n" rel="next">Post-install init-scripts and a bootloader. The init daemon is already provided by busybox, but you can optionally change it. </p> - - -<span id="Installing-a-bootloader"></span><h4 class="subsection">1.5.1 Installing a bootloader</h4> - -<p>In the main repository, there is efibootmgr and grub to serve as bootloaders. -efibootmgr can be used as a standalone bootloader, or can be used to install -grub in a UEFI environment. efibootmgr is needed unless you are using a device -without UEFI support (or you really want to use BIOS for a reason). -</p> -<p>GRUB BIOS installation -</p> -<div class="example"> -<pre class="example">$ cpt b grub && cpt i grub -$ grub-install --target=i386-pc /dev/sdX -$ grub-mkconfig -o /boot/grub/grub.cfg -</pre></div> - -<p>GRUB UEFI installation -</p> -<div class="example"> -<pre class="example">$ cpt b efibootmgr && cpt i efibootmgr -$ cpt b grub && cpt i grub - -$ grub-install --target=x86_64-efi \ - --efi-directory=esp \ - --bootloader-id=CarbsLinux - -$ grub-mkconfig -o /boot/grub/grub.cfg -</pre></div> - - - -<span id="Installing-init-scripts"></span><h4 class="subsection">1.5.2 Installing init scripts</h4> - -<p>Only thing left to do is installing the init-scripts, and now you are almost -ready to boot your system! -</p> -<div class="example"> -<pre class="example">$ cpt b carbs-init && cpt i carbs-init -</pre></div> - - - -<span id="Generating-fstab"></span><h4 class="subsection">1.5.3 Generating fstab</h4> - -<p>You can now manually edit your fstab entry, or you can use the genfstab tool. -If you want to use the tool, exit the chroot and run the following: -</p> -<div class="example"> -<pre class="example">$ wget https://github.com/cemkeylan/genfstab/raw/master/genfstab -$ chmod +x genfstab -$ ./genfstab -U /mnt >> /mnt/etc/fstab -</pre></div> - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Bootloader.html" accesskey="1">Bootloader</a></td><td> </td><td align="left" valign="top">Install a bootloader for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-scripts.html" accesskey="2">Init scripts</a></td><td> </td><td align="left" valign="top">Install init scripts for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Fstab.html" accesskey="3">Fstab</a></td><td> </td><td align="left" valign="top">Generating fstab +</td></tr> +</table> diff --git a/docs/docs/Obtain-the-chroot-helper.html b/docs/docs/Obtain-the-chroot-helper.html new file mode 100644 index 0000000..e5fc1d3 --- /dev/null +++ b/docs/docs/Obtain-the-chroot-helper.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Obtain the chroot helper (Carbs Linux User Manual)</title> + +<meta name="description" content="Obtain the chroot helper (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtain the chroot helper (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Chroot.html" rel="next" title="Chroot"> +<link href="Extracting-the-tarball.html" rel="prev" title="Extracting the tarball"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Obtain-the-chroot-helper"></span><div class="header"> +<p> +Previous: <a href="Extracting-the-tarball.html" accesskey="p" rel="prev">Extracting the tarball</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Obtain-the-chroot-helper-1"></span><h4 class="subsection">1.1.4 Obtain the chroot helper</h4> + +<p>You can obtain the ‘<samp>cpt-chroot</samp>’ script in order to do a simple chroot into your +new root filesystem. +</p> +<div class="example"> +<pre class="example">wget https://dl.carbslinux.org/distfiles/cpt-chroot +chmod a+x cpt-chroot +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/cpt_002dinstall.html b/docs/docs/Obtaining-the-documentation.html index ed82923..03739b5 100644 --- a/docs/docs/cpt_002dinstall.html +++ b/docs/docs/Obtaining-the-documentation.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-install (Carbs Linux User Manual)</title> +<title>Obtaining the documentation (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-install (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-install (Carbs Linux User Manual)"> +<meta name="description" content="Obtaining the documentation (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtaining the documentation (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dlist.html" rel="next" title="cpt-list"> -<link href="cpt_002dfetch.html" rel="prev" title="cpt-fetch"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="System-Configuration.html" rel="next" title="System Configuration"> +<link href="Essential-Software.html" rel="prev" title="Essential Software"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,29 +47,28 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dinstall"></span><div class="header"> +<span id="Obtaining-the-documentation"></span><div class="header"> <p> -Next: <a href="cpt_002dlist.html" accesskey="n" rel="next"><code>cpt-list</code></a>, Previous: <a href="cpt_002dfetch.html" accesskey="p" rel="prev"><code>cpt-fetch</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="Essential-Software.html" accesskey="p" rel="prev">Essential Software</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dinstall-1"></span><h4 class="subsection">2.1.6 <code>cpt-install</code></h4> +<span id="Obtaining-the-documentation-1"></span><h4 class="subsection">1.2.5 Obtaining the documentation</h4> -<p><code>cpt-install</code> will install given packages. +<p>All the documentation for Carbs Linux can be found on a single info manual to be +viewed offline. You can obtain texinfo or the info (standalone) package in order +to view the documentation. </p> +<div class="example"> +<pre class="example"># Install the documentation. +cpt b carbs-docs && cpt i carbs-docs +# Install either texinfo or the info package. We will be installing standalone info +# as it doesn't need perl. +cpt b info && cpt i info -<span id="Options-1"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-f --force</samp></dt> -<dd><p>Force installation. See <a href="Environment-Variables.html#cptforce"><code>CPT_FORCE</code></a>. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Set an alternative root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - +# You can then run info and navigate through the documentation. +info carbslinux +</pre></div> diff --git a/docs/docs/cpt_002dbuild.html b/docs/docs/Obtaining-the-kernel-sources.html index c15e41c..5acdb26 100644 --- a/docs/docs/cpt_002dbuild.html +++ b/docs/docs/Obtaining-the-kernel-sources.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-build (Carbs Linux User Manual)</title> +<title>Obtaining the kernel sources (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-build (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-build (Carbs Linux User Manual)"> +<meta name="description" content="Obtaining the kernel sources (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtaining the kernel sources (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dchecksum.html" rel="next" title="cpt-checksum"> -<link href="cpt_002dalternatives.html" rel="prev" title="cpt-alternatives"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Kernel-dependencies.html" rel="next" title="Kernel dependencies"> +<link href="Kernel.html" rel="prev" title="Kernel"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,30 +47,25 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dbuild"></span><div class="header"> +<span id="Obtaining-the-kernel-sources"></span><div class="header"> <p> -Next: <a href="cpt_002dchecksum.html" accesskey="n" rel="next"><code>cpt-checksum</code></a>, Previous: <a href="cpt_002dalternatives.html" accesskey="p" rel="prev"><code>cpt-alternatives</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Kernel-dependencies.html" accesskey="n" rel="next">Kernel dependencies</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dbuild-1"></span><h4 class="subsection">2.1.2 <code>cpt-build</code></h4> +<span id="Obtaining-the-kernel-sources-1"></span><h4 class="subsection">1.4.1 Obtaining the kernel sources</h4> -<p><code>cpt-build</code> will build given packages and their dependencies. If -multiple packages are specified, it will ask to install the packages as well. +<p>You can visit the <a href="https://kernel.org">https://kernel.org</a> website to choose a kernel that you want +to install. Though only the latest stable and longterm (LTS) versions are +supported. </p> +<div class="example"> +<pre class="example"># Download the kernel and extract it +wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz +tar xf linux-5.9.1.tar.xz - -<span id="Options"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-y --no-prompt</samp></dt> -<dd><p>Do not prompt for confirmation -</p></dd> -<dt><samp>-t --test</samp></dt> -<dd><p>Run tests (if it exists) -</p></dd> -</dl> - - +# Change directory into the kernel sources +cd linux-5.9.1 +</pre></div> diff --git a/docs/docs/Package-Manager.html b/docs/docs/Package-Manager.html deleted file mode 100644 index 14ca738..0000000 --- a/docs/docs/Package-Manager.html +++ /dev/null @@ -1,81 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Package Manager (Carbs Linux User Manual)</title> - -<meta name="description" content="Package Manager (Carbs Linux User Manual)"> -<meta name="keywords" content="Package Manager (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="index.html" rel="up" title="Top"> -<link href="Usage.html" rel="next" title="Usage"> -<link href="Post_002dinstallation.html" rel="prev" title="Post-installation"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Package-Manager"></span><div class="header"> -<p> -Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previous: <a href="Installation.html" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Package-Manager-1"></span><h2 class="chapter">2 Package Manager</h2> - -<p>Carbs Linux uses its own package managing toolchain named <code>cpt</code>. It is a -fork of the <a href="https://github.com/kisslinux/kiss">kiss</a> package manager. -Unlike <code>kiss</code>, however, its main goal is being easily extendable. -Instead of being a single file package manager, it revolves around the shell -library <code>cpt-lib</code>, and many tools that wrap around it. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Usage.html" accesskey="1">Usage</a></td><td> </td><td align="left" valign="top">Using Carbs Packaging Tools -</td></tr> -<tr><td align="left" valign="top">• <a href="Environment-Variables.html" accesskey="2">Environment Variables</a></td><td> </td><td align="left" valign="top">Values that affect the operation of CPT -</td></tr> -<tr><td align="left" valign="top">• <a href="Hooks.html" accesskey="3">Hooks</a></td><td> </td><td align="left" valign="top">Using hooks to customize the package manager operations -</td></tr> -<tr><td align="left" valign="top">• <a href="Packaging-System.html" accesskey="4">Packaging System</a></td><td> </td><td align="left" valign="top">More detail on creating packages -</td></tr> -<tr><td align="left" valign="top">• <a href="Rsync-Repositories.html" accesskey="5">Rsync Repositories</a></td><td> </td><td align="left" valign="top">Information on using or creating rsync repositories -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/docs/docs/Packaging-System.html b/docs/docs/Packaging-System.html deleted file mode 100644 index 7268068..0000000 --- a/docs/docs/Packaging-System.html +++ /dev/null @@ -1,226 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Packaging System (Carbs Linux User Manual)</title> - -<meta name="description" content="Packaging System (Carbs Linux User Manual)"> -<meta name="keywords" content="Packaging System (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Rsync-Repositories.html" rel="next" title="Rsync Repositories"> -<link href="Editing-the-build-file-during-pre_002dbuild.html" rel="prev" title="Editing the build file during pre-build"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Packaging-System"></span><div class="header"> -<p> -Next: <a href="Rsync-Repositories.html" accesskey="n" rel="next">Rsync Repositories</a>, Previous: <a href="Hooks.html" accesskey="p" rel="prev">Hooks</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Packaging-System-1"></span><h3 class="section">2.4 Packaging System</h3> - -<p>A package is formed of several files, these are: -</p><ul> -<li> <samp>build</samp> -</li><li> <samp>sources</samp> -</li><li> <samp>checksums</samp> -</li><li> <samp>version</samp> -</li><li> <samp>depends</samp> -</li><li> <samp>post-install</samp> -</li><li> <samp>message</samp> -</li><li> <samp>test</samp> -</li></ul> - -<p>Any other file can be added to the package directory at the discretion of the -package maintainer. Everything in the package directory will also be added to the -package database that is located on ’/var/db/cpt/installed’. These can be -patches, configuration files, etc. -</p> - - -<span id="build"></span><h4 class="subsection">2.4.1 <samp>build</samp></h4> - -<p>Typically <samp>build</samp> files are shell scripts that run commands to prepare the source -code to be installed on the target system. Even though we will be assuming that -the <samp>build</samp> file is a POSIX shell script (for portability’s sake), <samp>build</samp> -files can be any executable program from binary programs to <code>perl</code> scripts. -</p> -<p>The contents of a build script do not need to follow a certain rule for the -package manager, except for the fact that the user needs the permission to -execute the file. -</p> -<p>An important advice is to append an ’-e’ to the shebang (#!/bin/sh -e) so that -the build script exits on compilation error. -</p> -<p>Build is run with three arguments (<code>$#</code>) -</p> -<ol> -<li> Location of the package directory (DESTDIR) -</li><li> Package version -</li><li> System architecture -</li></ol> - - - -<span id="sources"></span><h4 class="subsection">2.4.2 <samp>sources</samp></h4> - -<p><samp>sources</samp> file is a list of files and sources that will be put to the build -directory during the build process. Those can be remote sources (such as tarballs), -git repositories, and files that reside on the package directory. -</p> -<p>The syntax is pretty simple for the <samp>soures</samp> file; <tt>src dest</tt>. The -<code>dest</code> parameter is optional. It is the directory that the source will be -placed in. Here is the <samp>sources</samp> file for the <code>gst-plugins</code> package: -</p> -<div class="example"> -<pre class="example">https://gstreamer.freedesktop.org/src/gst-plugins-good/gst-plugins-good-1.16.2.tar.xz good -https://gstreamer.freedesktop.org/src/gst-plugins-bad/gst-plugins-bad-1.16.2.tar.xz bad -https://gstreamer.freedesktop.org/src/gst-plugins-ugly/gst-plugins-ugly-1.16.2.tar.xz ugly -https://gstreamer.freedesktop.org/src/gst-libav/gst-libav-1.16.2.tar.xz libav -</pre></div> - -<p>This file is read from the package manager as space seperated. Files that begin -with a ’#’ comment are ignored. The first value points to the location of the -source. -</p> -<p>If it starts with a protcol url, (such as ftp:// http:// https://) it will be -downloaded with <code>curl</code>. -</p> -<p>If the source is a git repository, it shall be prefixed with a <tt>git+</tt> git(1) will -be used to do a shallow clone of the repository. If the commit is suffixed by a -history pointer, git will checkout the relevant revision. So, -</p> -<dl compact="compact"> -<dt>‘<code>git+git://example.com/pub/repo#v1.2.3</code>’</dt> -<dd><p>will checkout the tag named ’v1.2.3’ -</p></dd> -<dt>‘<code>git+git://example.com/pub/repo#development</code>’</dt> -<dd><p>will checkout the branch named ’development’ -</p></dd> -<dt>‘<code>git+git://example.com/pub/repo#1a314s87</code>’</dt> -<dd><p>will checkout the commit named ’1a314s87’ -</p></dd> -</dl> - -<p>Other files are assumed to be residing in the package directory. They should be -added with their paths relative to the package directory. -</p> - - -<span id="checksums"></span><h4 class="subsection">2.4.3 <samp>checksums</samp></h4> - -<p>checksums file is generated by the <samp>cpt c pkg command</samp>. It is generated -according to the order of the sources file. That’s why you shouldn’t be editing -it manually. The checksums file is created with the digests of the files using -the sha256 algorithm. -</p> - - -<span id="version"></span><h4 class="subsection">2.4.4 <samp>version</samp></h4> - -<p>The version file includes the version of the software and the release number of -of the package on a space seperated format. The contents of the file should look -like below. -</p> -<div class="example"> -<pre class="example">1.3.2 1 -</pre></div> - -<p>The version should always match to the number of the upstream release. For -drastic changes that require a rebuild Those can be, -</p> -<ul> -<li> update of libraries that forces the package to be relinked -</li><li> change in the build scripts that affect the output of the package -</li></ul> - -<p>When a version bump occurs, the release should be reset to 1. -</p> - - -<span id="depends"></span><h4 class="subsection">2.4.5 <samp>depends</samp></h4> - -<p>This is a list of dependencies that must be installed before a package build. You -can append “make” after a dependency to mark a package is only required during -the build process of a package. Packages marked as a make dependency can be -removed after the build. There are also “test” dependencies. These dependencies -are only installed if either the <code>CPT_TEST</code> is set to 1, or the build is run -with the <samp>-t</samp> or <samp>--test</samp> options. So, a package package could have -the following <samp>depends</samp> file: -</p> -<div class="example"> -<pre class="example">linux-headers make -python test -zlib -</pre></div> - - - -<span id="post_002dinstall"></span><h4 class="subsection">2.4.6 <samp>post-install</samp></h4> - -<p><samp>post-install</samp> files have the same requirements as the build script. They -will be run after the package is installed as root (or as the user if the user -has write permissions on <code>CPT_ROOT</code>). -</p> - - -<span id="message"></span><h4 class="subsection">2.4.7 <samp>message</samp></h4> - -<p>This plaintext file will be outputted with <code>cat</code> after every package is -installed. -</p> - - -<span id="test"></span><h4 class="subsection">2.4.8 <samp>test</samp></h4> - -<p>Test files are mainly for the repository maintainer to test the packages, and -will only run if the user has the <code>CPT_TEST</code> variable set, or the build is -run with the <samp>-t</samp> or <samp>--test</samp> options. This script is run on the -build directory. It is run right after the build script is finished. -</p> - - -<hr> -<div class="header"> -<p> -Next: <a href="Rsync-Repositories.html" accesskey="n" rel="next">Rsync Repositories</a>, Previous: <a href="Hooks.html" accesskey="p" rel="prev">Hooks</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/docs/docs/Post_002dinstallation.html b/docs/docs/Post_002dinstallation.html index 6afbb2d..da1dc05 100644 --- a/docs/docs/Post_002dinstallation.html +++ b/docs/docs/Post_002dinstallation.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Package-Manager.html" rel="next" title="Package Manager"> -<link href="Making-your-system-bootable.html" rel="prev" title="Making your system bootable"> +<link href="KISS-repositories.html" rel="next" title="KISS repositories"> +<link href="Fstab.html" rel="prev" title="Fstab"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -55,29 +56,12 @@ Previous: <a href="Making-your-system-bootable.html" accesskey="p" rel="prev">Ma <p>The base installation is now complete, you can now fine tune your system according to your needs. Rest of these instructions are completely optional. +You can check the rest of the documentation to learn more about the system. </p> - - -<span id="Acquiring-kiss-repositories"></span><h4 class="subsection">1.6.1 Acquiring kiss repositories</h4> - -<p>While not 100% compatible with cpt, you can use kiss repositories in your -system the same way you are using the distribution repositories. Here is an -example for the KISS Linux Community repository. -</p> -<div class="example"> -<pre class="example">$ git clone https://github.com/kisslinux/community $HOME/repos/kiss-community -$ export CPT_PATH=$CPT_PATH:$HOME/repos/kiss-community/community -</pre></div> - -<p>NOTE: There are lots of packages on the KISS community repository that are also -on Carbs Linux main repository. I would advise giving lower priority to the KISS -community repository as it may affect other packages that you might install. -</p> - - - - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="KISS-repositories.html" accesskey="1">KISS repositories</a></td><td> </td><td align="left" valign="top">Acquire kiss repositories +</td></tr> +</table> diff --git a/docs/docs/Preparing-Environment.html b/docs/docs/Preparing-Environment.html index a5c43f9..89fc029 100644 --- a/docs/docs/Preparing-Environment.html +++ b/docs/docs/Preparing-Environment.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Chroot.html" rel="next" title="Chroot"> +<link href="Download.html" rel="next" title="Download"> <link href="Installation.html" rel="prev" title="Installation"> <style type="text/css"> <!-- @@ -52,6 +53,7 @@ Next: <a href="Chroot.html" accesskey="n" rel="next">Chroot</a>, Up: <a href="In </div> <hr> <span id="Preparing-Environment-1"></span><h3 class="section">1.1 Preparing Environment</h3> + <p>To install Carbs Linux, you will need a Live Linux ISO. For that purpose, you can obtain a Gentoo or Void Linux live image. You can follow their instructions to boot and setup your network. @@ -68,81 +70,18 @@ to boot and setup your network. <p>Rest of these instructions will assume that you have set all of these up, and will continue on that point. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Download.html" accesskey="1">Download</a></td><td> </td><td align="left" valign="top">Download the root filesystem tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Signature-verification.html" accesskey="2">Signature verification</a></td><td> </td><td align="left" valign="top">Verify the signature of the rootfs tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Extracting-the-tarball.html" accesskey="3">Extracting the tarball</a></td><td> </td><td align="left" valign="top">Extracting the root filesystem to the desired location +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtain-the-chroot-helper.html" accesskey="4">Obtain the chroot helper</a></td><td> </td><td align="left" valign="top">Download the script to easily chroot into the new filesystem +</td></tr> +</table> -<span id="Download"></span><h4 class="subsection">1.1.1 Download</h4> - -<p>First, we need to download the rootfs tarball. You can do the following in order -to obtain the rootfs. If you are using an i686 machine, replace the -<code>x86_64</code> with <code>i686</code>. We are setting this in a URL variable so that we -don’t have to write it every time. -</p> -<div class="example"> -<pre class="example">$ URL=https://dl.carbslinux.org/releases/x86_64 -$ wget $URL/carbs-rootfs.tar.xz -</pre></div> - -<p>We can then check the integrity of the tarball and do a signature verification. -Even thought these are optional, they are highly recommended. -</p> - - -<span id="Check-the-integrity-of-the-tarball-_0028Recommended_0029"></span><h4 class="subsection">1.1.2 Check the integrity of the tarball (Recommended)</h4> - -<p>All of the releases are saved in a single file named <samp>sha256sums.txt</samp>, but -the latest release is saved on <samp>carbs-rootfs.tar.xz.sha256</samp>. You can -acquire and verify the tarball. -</p> -<div class="example"> -<pre class="example">$ wget $URL/carbs-rootfs.tar.xz.sha256 -$ sha256sum -c carbs-rootfs.tar.xz.sha256 -</pre></div> - - - -<span id="Verify-the-signature"></span><h4 class="subsection">1.1.3 Verify the signature</h4> - -<p>It is highly recommended to verify the signature of the tarball. You will need -GPG for this. -</p> -<div class="example"> -<pre class="example">$ wget $URL/carbs-rootfs.tar.xz.sig -$ gpg --recv-keys FF484BDFEFCEF8FF -$ gpg --verify carbs-rootfs.tar.xz.sig -</pre></div> - - - -<span id="Extracting-the-tarball"></span><h4 class="subsection">1.1.4 Extracting the tarball</h4> - -<p>You will need to extract the tarball to your desired location. For partitioning, -you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. -This will assume that you will be mounting your root partition to <samp>/mnt</samp>. -</p> -<div class="example"> -<pre class="example">$ mount /dev/sdx1 /mnt -$ tar xf carbs-rootfs.tar.xz -C /mnt -</pre></div> - - - -<span id="Obtain-the-chroot-helper"></span><h4 class="subsection">1.1.5 Obtain the chroot helper</h4> - -<p>You can obtain the <code>cpt-chroot</code> script in order to do a simple chroot into -your new root filesystem. -</p> -<div class="example"> -<pre class="example">$ wget https://dl.carbslinux.org/distfiles/cpt-chroot -$ chmod a+x cpt-chroot -</pre></div> - - -<hr> -<div class="header"> -<p> -Next: <a href="Chroot.html" accesskey="n" rel="next">Chroot</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/docs/docs/Rebooting-after-changing-init.html b/docs/docs/Rebooting-after-changing-init.html new file mode 100644 index 0000000..85d02cf --- /dev/null +++ b/docs/docs/Rebooting-after-changing-init.html @@ -0,0 +1,73 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Rebooting after changing init (Carbs Linux User Manual)</title> + +<meta name="description" content="Rebooting after changing init (Carbs Linux User Manual)"> +<meta name="keywords" content="Rebooting after changing init (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Changing-Init-Program.html" rel="up" title="Changing Init Program"> +<link href="Contribution-Guidelines.html" rel="next" title="Contribution Guidelines"> +<link href="Changing-Init-Program.html" rel="prev" title="Changing Init Program"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Rebooting-after-changing-init"></span><div class="header"> +<p> +Up: <a href="Changing-Init-Program.html" accesskey="u" rel="up">Changing Init Program</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Rebooting-after-changing-init-1"></span><h4 class="subsection">2.2.1 Rebooting after changing init</h4> + +<p>After switching init systems, your running init system may not accept the +new poweroff commands. You will need to reboot/poweroff using the running init’s +utilities for the new utilities to work. These commands are for the init system +currently running on your system and not the one you are switching to. +</p> +<table> +<thead><tr><th>Program</th><th>Command</th></tr></thead> +<tr><td>busybox</td><td>‘<samp>busybox reboot</samp>’</td></tr> +<tr><td>runit</td><td>‘<samp>runit-init 6</samp>’</td></tr> +<tr><td>shinit/sinit</td><td>‘<samp>kill -s INT 1</samp>’</td></tr> +</table> + + + + +</body> +</html> diff --git a/docs/docs/Repository-Conventions.html b/docs/docs/Repository-Conventions.html index e333ff6..598cc7a 100644 --- a/docs/docs/Repository-Conventions.html +++ b/docs/docs/Repository-Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Conventions.html" rel="up" title="Conventions"> -<link href="Sending-Git-mails.html" rel="next" title="Sending Git mails"> +<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free Documentation License"> <link href="Shell-Conventions.html" rel="prev" title="Shell Conventions"> <style type="text/css"> <!-- @@ -51,52 +52,49 @@ ul.no-bullet {list-style: none} Previous: <a href="Shell-Conventions.html" accesskey="p" rel="prev">Shell Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Repository-Conventions-_002d_002d-20"></span><h4 class="subsection">4.1.3 Repository Conventions – 20</h4> +<span id="Repository-Conventions-1"></span><h4 class="subsection">3.1.2 Repository Conventions</h4> <p>Repository conventions are important in order to ensure every package resemble themselves. Here are the things to keep in mind: </p> <dl compact="compact"> -<dt><strong>[<span id="g_t2010"></span>2010]</strong></dt> -<dd><p>Prefer tarballs over git packages unless there is a sensible reason. -Here are some: -</p> -<ul> +<dt>[<span id="g_t2010"></span>2010]</dt> +<dd><p>Prefer tarballs over git packages unless there is a +sensible reason. Here are some: +</p><ul> <li> Every patch is a new release. (See <a href="https://github.com/vim/vim">vim</a>) -</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">https://git.suckless.org/sbase</a>) +</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">sbase</a>) </li><li> Following a development branch. -</li><li> There has been a long time since the latest release, but upstream is far ahead. +</li><li> There has been a long time since the latest release, but upstream is far +ahead. </li></ul> - </dd> -<dt><strong>[<span id="g_t2020"></span>2020]</strong></dt> -<dd><p>Prefer sources without a dependency to <code>automake</code>. There are usually -distribution tarballs that are <code>autoconf</code>’ed. Don’t submit tarballs -with an automake dependency unless you are <strong>sure</strong> there is no -alternative. +<dt>[<span id="g_t2020"></span>2020]</dt> +<dd><p>Prefer sources without a dependency to ‘<samp>automake</samp>’. There +are usually distribution tarballs that are ‘<samp>autoconf</samp>’’ed. Don’t submit tarballs +with an automake dependency unless you are ‘<samp>sure</samp>’ there is no alternative. </p></dd> -<dt><strong>[<span id="g_t2030"></span>2030]</strong></dt> +<dt>[<span id="g_t2030"></span>2030]</dt> <dd><p>Avoid these packages: </p><dl compact="compact"> -<dt><code>dbus</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-dbus</samp> +<dt>dbus</dt> +<dd><p>Usually can be disabled by <code>--disable-dbus</code>. </p></dd> -<dt><code>gettext</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-nls</samp> +<dt>gettext</dt> +<dd><p>Usually can be disabled by <code>--disable-nls</code>. </p></dd> </dl> </dd> -<dt><strong>[<span id="g_t2040"></span>2040]</strong></dt> +<dt>[<span id="g_t2040"></span>2040]</dt> <dd><ul> -<li> Always install a package to the <samp>/usr</samp> prefix. -</li><li> All binaries should go to <samp>/usr/bin</samp>, not <samp>/usr/sbin</samp> or any other -directory. -</li><li> All libraries should go to <samp>/usr/lib</samp>. +<li> Always install a package to the ‘<samp>/usr</samp>’ prefix. +</li><li> All binaries should go to ‘<samp>/usr/bin</samp>’, not ‘<samp>/usr/sbin</samp>’ or any other directory. +</li><li> All libraries should go to ‘<samp>/usr/lib</samp>’. </li></ul> </dd> -<dt><strong>[<span id="g_t2050"></span>2050]</strong></dt> -<dd><p>All build files on the repository should be a POSIX shell script, and must start -with <code>#!/bin/sh -e</code>. +<dt>[<span id="g_t2050"></span>2050]</dt> +<dd><p>All build files on the repository should be a POSIX +shell script, and must start with <code>#!/bin/sh -e</code>. </p></dd> </dl> @@ -104,10 +102,10 @@ with <code>#!/bin/sh -e</code>. ensure stylistic consistency. Note that the option configurations shouldn’t be taken literally, they are meant as examples. </p> +<ol> +<li> Make [<span id="g_t2210"></span>2210] -<p><strong>[<span id="g_t2210"></span>2210] Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -115,10 +113,9 @@ make make DESTDIR="$1" PREFIX=/usr install </pre></div> +</li><li> Configure/Make [<span id="g_t2211"></span>2211] -<p><strong>[<span id="g_t2211"></span>2211] Configure/Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -131,10 +128,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Autoconf/Automake [<span id="g_t2212"></span>2212] -<p><strong>[<span id="g_t2212"></span>2212] Autoconf/Automake</strong> -</p> <p>See <a href="#g_t2020">2020</a> </p> <div class="example"> @@ -151,10 +147,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Meson [<span id="g_t2220"></span>2220] -<p><strong>[<span id="g_t2220"></span>2220] Meson</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -170,10 +165,9 @@ ninja -C output ninja -C output install </pre></div> +</li><li> Cmake [<span id="g_t2230"></span>2230] -<p><strong>[<span id="g_t2230"></span>2230] Cmake</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -188,10 +182,9 @@ cmake --build build cmake --install build </pre></div> +</li><li> Go [<span id="g_t2240"></span>2240] -<p><strong>[<span id="g_t2240"></span>2240] Go</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -203,18 +196,16 @@ go build install -Dm755 program "$1/usr/bin/program" </pre></div> +</li><li> Python [<span id="g_t2241"></span>2241] -<p><strong>[<span id="g_t2241"></span>2241] Python</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e python setup.py build python setup.py install --prefix=/usr --root="$1" </pre></div> - - +</li></ol> <hr> <div class="header"> diff --git a/docs/docs/Rsync-Repositories.html b/docs/docs/Rsync-Repositories.html deleted file mode 100644 index fc67f9a..0000000 --- a/docs/docs/Rsync-Repositories.html +++ /dev/null @@ -1,109 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Rsync Repositories (Carbs Linux User Manual)</title> - -<meta name="description" content="Rsync Repositories (Carbs Linux User Manual)"> -<meta name="keywords" content="Rsync Repositories (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Setting-up-an-rsync-repository-for-distribution.html" rel="next" title="Setting up an rsync repository for distribution"> -<link href="Packaging-System.html" rel="prev" title="Packaging System"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Rsync-Repositories"></span><div class="header"> -<p> -Previous: <a href="Packaging-System.html" accesskey="p" rel="prev">Packaging System</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Rsync-Repositories-1"></span><h3 class="section">2.5 Rsync Repositories</h3> - -<p>Rsync repositories are simple to serve and simple to use. In the repository -directory, there needs to be a ’.rsync’ file that points to the remote of the -repository. This is used in order to fetch changes from the upstream. ’.rsync’ -file looks like this for the core repository: -</p> -<div class="example"> -<pre class="example">rsync://carbslinux.org/repo/core -</pre></div> - -<p>Rsync repositories have some few distinctions when it comes to fetching them. -They can be either synced individually or as a “root”. There are 2 important -files, those are <samp>.rsync</samp> and <samp>.rsync_root</samp>. Here is the Carbs Linux -rsync repository structure. -</p> -<div class="example"> -<pre class="example"> / - ----------------- - | | -.rsync core/ - ---------------- - | | - .rsync .rsync_root -</pre></div> - -<p>Unlike git repositories, they don’t have a defined “root” directory. This is -both an advantage and a disadvantage. This way, we can sync individual -repositories, but that also means we need extra files to define root directories -and repository locations. Here is the content for each of these files: -</p> -<div class="example"> -<pre class="example">/.rsync: rsync://carbslinux.org/repo -/core/.rsync: rsync://carbslinux.org/repo/core -/core/.rsync_root: .. -</pre></div> - -<p>The <samp>.rsync_root</samp> file on the core repository points to the upper directory. -If a <samp>.rsync</samp> file exists on the upper directory, this means that is the whole -repository and will sync the entire repository instead of each individual repository. -</p> -<p>If the upper directory doesn’t have this <samp>.rsync</samp> file, this means that this -is an individual repository, and the package manager will fetch accordingly. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Setting-up-an-rsync-repository-for-distribution.html" accesskey="1">Setting up an rsync repository for distribution</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/docs/docs/Sending-Git-mails.html b/docs/docs/Sending-Git-mails.html deleted file mode 100644 index 5dcfbe6..0000000 --- a/docs/docs/Sending-Git-mails.html +++ /dev/null @@ -1,106 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Sending Git mails (Carbs Linux User Manual)</title> - -<meta name="description" content="Sending Git mails (Carbs Linux User Manual)"> -<meta name="keywords" content="Sending Git mails (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> -<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free Documentation License"> -<link href="Repository-Conventions.html" rel="prev" title="Repository Conventions"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Sending-Git-mails"></span><div class="header"> -<p> -Previous: <a href="Conventions.html" accesskey="p" rel="prev">Conventions</a>, Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Sending-Git-mails-1"></span><h3 class="section">4.2 Sending Git mails</h3> - -<p>As mentioned, the preferred way of contribution is via patches. The easiest way -for sending git mails without <code>git send-email</code> is using <code>msmtp</code>. -You can install it from the repository by doing: -</p> -<div class="example"> -<pre class="example">$ cpt b msmtp && cpt i msmtp -</pre></div> - -<p>You can then edit <samp>~/.config/msmtp/config</samp> to add your email. Here is an -example configuration, you can use <code>pass</code>, <code>pash</code>, or any other -password manager that fits your needs: -</p> -<div class="example"> -<pre class="example">defaults -auth on -tls on -tls_trust_file /etc/ssl/certs/ca-certificates.crt -logfile ~/.config/msmtp/msmtp.log -account my-mail -host mail.example.com -port 587 -from me@example.com -user me@example.com -passwordeval "pass my-mail" -</pre></div> - -<p>In order to simply send your patch, do the following: -</p> -<div class="example"> -<pre class="example">$ git format-patch --to=~carbslinux/dev+subscribe@lists.sr.ht -1 --stdout | - msmtp -t -a my-mail -</pre></div> - -<p>You can also send multiple patches by doing the following: -</p> -<div class="example"> -<pre class="example">$ git format-patch --to=~carbslinux/dev+subscribe@lists.sr.ht <region> - -Edit those files as necessary and send them. -$ for file in *.patch; do msmtp -t -a my-mail < $patch; done -</pre></div> - - - - - - - - -</body> -</html> diff --git a/docs/docs/Setting-up-an-rsync-repository-for-distribution.html b/docs/docs/Setting-up-an-rsync-repository-for-distribution.html deleted file mode 100644 index ff97a37..0000000 --- a/docs/docs/Setting-up-an-rsync-repository-for-distribution.html +++ /dev/null @@ -1,109 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Setting up an rsync repository for distribution (Carbs Linux User Manual)</title> - -<meta name="description" content="Setting up an rsync repository for distribution (Carbs Linux User Manual)"> -<meta name="keywords" content="Setting up an rsync repository for distribution (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Rsync-Repositories.html" rel="up" title="Rsync Repositories"> -<link href="Init-System.html" rel="next" title="Init System"> -<link href="Rsync-Repositories.html" rel="prev" title="Rsync Repositories"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Setting-up-an-rsync-repository-for-distribution"></span><div class="header"> -<p> -Up: <a href="Rsync-Repositories.html" accesskey="u" rel="up">Rsync Repositories</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Setting-up-an-rsync-repository-for-distribution-1"></span><h4 class="subsection">2.5.1 Setting up an rsync repository for distribution</h4> - -<p>Carbs Linux repositories automatically sync from the git repostitories and serve -it through the rsync daemon. Here is a sample shell script that I use in order to -sync repositories. Feel free to customize for your own use. -</p> -<pre class="verbatim"> #!/bin/sh - HOSTNAME="rsync://carbslinux.org/repo" - GITDIR="/pub/git/repo" - SHAREDIR="/pub/share/repo" - git -C "$GITDIR" pull - - rsync -avcC --delete --include=core --exclude=.rsync,.rsync_root "$GITDIR/." "$SHAREDIR" - - printf '%s\n' "$HOSTNAME" > "$GITDIR/.rsync" - for dir in "$GITDIR/"*; do - [ -d "$dir" ] || continue - [ -f "$dir/.rsync" ] || - printf '%s/%s\n' "$HOSTNAME" "${dir##*/}" > "$dir/.rsync" - printf '..\n' > "$dir/.rsync_root" - done -</pre> -<p>You can then create an <strong>rsync</strong> user for serving the repositories. -</p> -<div class="example"> -<pre class="example">$ adduser -SD rsync -</pre></div> - -<p>Create <samp>/etc/rsyncd.conf</samp> and a service configuration as well. -</p> -<pre class="verbatim"> - uid = rsync - gid = rsync - address = example.com - max connections = 10 - use chroot = yes - - [repo] - path = /pub/share/repo - comment = My repository -</pre> -<p>Create a service file at <samp>/etc/sv/rsync/run</samp> (runit): -</p> -<div class="example"> -<pre class="example">#!/bin/sh -exec rsync --daemon --no-detach -</pre></div> - - - - - - - -</body> -</html> diff --git a/docs/docs/Setting-up-repositories.html b/docs/docs/Setting-up-repositories.html new file mode 100644 index 0000000..44360ab --- /dev/null +++ b/docs/docs/Setting-up-repositories.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Setting up repositories (Carbs Linux User Manual)</title> + +<meta name="description" content="Setting up repositories (Carbs Linux User Manual)"> +<meta name="keywords" content="Setting up repositories (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Updating-packages.html" rel="next" title="Updating packages"> +<link href="Chroot.html" rel="prev" title="Chroot"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Setting-up-repositories"></span><div class="header"> +<p> +Next: <a href="Updating-packages.html" accesskey="n" rel="next">Updating packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Setting-up-repositories-1"></span><h4 class="subsection">1.2.1 Setting up repositories</h4> + +<p>Newest tarballs do not come with repositories, so you will need to manually +obtain them, and set your ‘<samp>CPT_PATH</samp>’ environment variable. Carbs Linux +repositories can either be obtained by ‘<samp>git</samp>’ or ‘<samp>rsync</samp>’. While rsync +repositories are overall faster and smaller, git offers the whole history of the +repository and a means to manipulate your repository as you like it. If you want +to obtain the git repository, you will need to install ‘<samp>git</samp>’ itself. +</p> +<p>The following guide will assume that you put the repositories into ‘<samp>~/repos/</samp>’ +directory, but you can put the repositories into any directory you want. So go +ahead and create that directory: +</p> +<div class="example"> +<pre class="example">mkdir -p $HOME/repos +</pre></div> + +<ol> +<li> Obtaining from git + + +<p>Carbs Linux git repositories can be found both from the main server and GitHub +(mirror). Here are both their repository links. You can clone any of them. +</p> +<ul> +<li> git://git.carbslinux.org/repository +</li><li> <a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a> +</li></ul> + +<div class="example"> +<pre class="example">git clone git://git.carbslinux.org/repository $HOME/repos/carbs +</pre></div> + +</li><li> Obtaining from rsync + + +<p>Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In +order to obtain it, run the following: +</p> +<div class="example"> +<pre class="example">rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs +</pre></div> + +</li><li> Making the package manager use the repositories + + +<p>In your shell’s configuration file, or in your ‘<samp>~/.profile</samp>’ file, add the +following lines: +</p> +<div class="example"> +<pre class="example">CPT_PATH=$HOME/repos/carbs/core +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community +export CPT_PATH +</pre></div> +</li></ol> + + + + +</body> +</html> diff --git a/docs/docs/Shell-Conventions.html b/docs/docs/Shell-Conventions.html index cb040d0..dd841de 100644 --- a/docs/docs/Shell-Conventions.html +++ b/docs/docs/Shell-Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Conventions.html" rel="up" title="Conventions"> <link href="Repository-Conventions.html" rel="next" title="Repository Conventions"> -<link href="General-Conventions.html" rel="prev" title="General Conventions"> +<link href="Conventions.html" rel="prev" title="Conventions"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,57 +49,56 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Shell-Conventions"></span><div class="header"> <p> -Next: <a href="Repository-Conventions.html" accesskey="n" rel="next">Repository Conventions</a>, Previous: <a href="General-Conventions.html" accesskey="p" rel="prev">General Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Repository-Conventions.html" accesskey="n" rel="next">Repository Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Shell-Conventions-_002d_002d-10"></span><h4 class="subsection">4.1.2 Shell Conventions – 10</h4> +<span id="Shell-Conventions-1"></span><h4 class="subsection">3.1.1 Shell Conventions</h4> <p>Shell is central to Carbs Linux projects. Most of the tools and packages are written in POSIX sh. </p> <dl compact="compact"> -<dt><strong>[<span id="g_t1010"></span>1010]</strong></dt> +<dt>[<span id="g_t1010"></span>1010]</dt> <dd><p>Use 4 spaces for indentation, don’t use tabs. </p></dd> -<dt><strong>[<span id="g_t1020"></span>1020]</strong></dt> +<dt>[<span id="g_t1020"></span>1020]</dt> <dd><p>Make sure you don’t use bash-specific code. </p></dd> -<dt><strong>[<span id="g_t1030"></span>1030]</strong></dt> -<dd><p>Make sure you lint your code with <code>shellcheck</code> and if you are new to -POSIX sh, use <code>checkbashisms</code>. +<dt>[<span id="g_t1030"></span>1030]</dt> +<dd><p>Make sure you lint your code with ‘<samp>shellcheck</samp>’ and if +you are new to POSIX sh, use ‘<samp>checkbashisms</samp>’. </p></dd> -<dt><strong>[<span id="g_t1040"></span>1040]</strong></dt> -<dd><p>Don’t spawn new processes if you don’t absolutely need to, especially during -string manipulation. +<dt>[<span id="g_t1040"></span>1040]</dt> +<dd><p>Don’t spawn new processes if you don’t absolutely need +to, especially during string manipulation. </p><dl compact="compact"> -<dt><strong>[<span id="g_t1041"></span>1041]</strong></dt> -<dd><p>Never use a program for text manupilation that isn’t defined in the POSIX -standard. This includes <code>gawk</code> and <code>perl</code>. +<dt>[<span id="g_t1041"></span>1041]</dt> +<dd><p>Never use a program for text manupilation that isn’t +defined in the POSIX standard. This includes ‘<samp>gawk</samp>’ and ‘<samp>perl</samp>’. </p></dd> -<dt><strong>[<span id="g_t1042"></span>1042]</strong></dt> +<dt>[<span id="g_t1042"></span>1042]</dt> <dd><p>Instead of <code>$(basename $file)</code>, use <code>${file##*}</code>. </p></dd> -<dt><strong>[<span id="g_t1043"></span>1043]</strong></dt> +<dt>[<span id="g_t1043"></span>1043]</dt> <dd><p>Instead of <code>$(dirname $file)</code>, use <code>${file%/*}</code>. </p></dd> </dl> + <div class="example"> -<pre class="example"># This is the same thing as <code>basename /path/to/test.asc .asc</code> +<pre class="example"># This is the same thing as basename /path/to/test.asc .asc $ file=/path/to/test.asc file=${file##*/} file=${file%.asc} $ echo $file test </pre></div> </dd> -<dt><strong>[<span id="g_t1050"></span>1050]</strong></dt> -<dd><p>Instead of backticks, use <tt>$(..)</tt>. +<dt>[<span id="g_t1050"></span>1050]</dt> +<dd><p>Instead of backticks, use <code>$(..)</code>. </p></dd> </dl> - - </body> </html> diff --git a/docs/docs/Signature-verification.html b/docs/docs/Signature-verification.html new file mode 100644 index 0000000..8dccbe3 --- /dev/null +++ b/docs/docs/Signature-verification.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Signature verification (Carbs Linux User Manual)</title> + +<meta name="description" content="Signature verification (Carbs Linux User Manual)"> +<meta name="keywords" content="Signature verification (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Extracting-the-tarball.html" rel="next" title="Extracting the tarball"> +<link href="Download.html" rel="prev" title="Download"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Signature-verification"></span><div class="header"> +<p> +Next: <a href="Extracting-the-tarball.html" accesskey="n" rel="next">Extracting the tarball</a>, Previous: <a href="Download.html" accesskey="p" rel="prev">Download</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Signature-verification-1"></span><h4 class="subsection">1.1.2 Signature verification</h4> + +<p>It is highly recommended to verify the signature of the tarball. You will need +GPG for this. +</p> +<div class="example"> +<pre class="example">wget $URL/carbs-rootfs.tar.xz.sig +gpg --recv-keys FF484BDFEFCEF8FF +gpg --verify carbs-rootfs.tar.xz.sig +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/System-Configuration.html b/docs/docs/System-Configuration.html index f0cbaf5..76cf410 100644 --- a/docs/docs/System-Configuration.html +++ b/docs/docs/System-Configuration.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Kernel.html" rel="next" title="Kernel"> -<link href="Chroot.html" rel="prev" title="Chroot"> +<link href="Configuring-hostname.html" rel="next" title="Configuring hostname"> +<link href="Obtaining-the-documentation.html" rel="prev" title="Obtaining the documentation"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -56,31 +57,12 @@ Next: <a href="Kernel.html" accesskey="n" rel="next">Kernel</a>, Previous: <a hr <p>After you have finished installing some extra packages, you can configure your system to your liking. </p> - - -<span id="Configuring-hostname-_0028recommended_0029"></span><h4 class="subsection">1.3.1 Configuring hostname (recommended)</h4> - -<p>You might want to add a hostname, especially in a networked environment. Your -hostname will default to ’carbslinux’ unless you set this. -</p> -<div class="example"> -<pre class="example">$ echo your-hostname > /etc/hostname -</pre></div> - - - -<span id="Setting-up-hosts-file-_0028optional_0029"></span><h4 class="subsection">1.3.2 Setting up hosts file (optional)</h4> - -<p>You can edit your /etc/hosts file, which is the static lookup table for host -names. By default, there are two entries for localhost which are OKAY. You can -replace the ’localhost’ part of these entries to your hostname. -</p> -<div class="example"> -<pre class="example">127.0.0.1 localhost.localdomain localhost -::1 localhost.localdomain localhost ip6-localhost -</pre></div> - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Configuring-hostname.html" accesskey="1">Configuring hostname</a></td><td> </td><td align="left" valign="top">Setting up system hostname (recommended) +</td></tr> +<tr><td align="left" valign="top">• <a href="Hosts-file.html" accesskey="2">Hosts file</a></td><td> </td><td align="left" valign="top">Setting up hosts file for networking (optional) +</td></tr> +</table> diff --git a/docs/docs/cpt_002dlist.html b/docs/docs/Updating-packages.html index d31b5e2..0c65553 100644 --- a/docs/docs/cpt_002dlist.html +++ b/docs/docs/Updating-packages.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-list (Carbs Linux User Manual)</title> +<title>Updating packages (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-list (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-list (Carbs Linux User Manual)"> +<meta name="description" content="Updating packages (Carbs Linux User Manual)"> +<meta name="keywords" content="Updating packages (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dremove.html" rel="next" title="cpt-remove"> -<link href="cpt_002dinstall.html" rel="prev" title="cpt-install"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Installing-packages.html" rel="next" title="Installing packages"> +<link href="Setting-up-repositories.html" rel="prev" title="Setting up repositories"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,20 +47,20 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dlist"></span><div class="header"> +<span id="Updating-packages"></span><div class="header"> <p> -Next: <a href="cpt_002dremove.html" accesskey="n" rel="next"><code>cpt-remove</code></a>, Previous: <a href="cpt_002dinstall.html" accesskey="p" rel="prev"><code>cpt-install</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Installing-packages.html" accesskey="n" rel="next">Installing packages</a>, Previous: <a href="Setting-up-repositories.html" accesskey="p" rel="prev">Setting up repositories</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dlist-1"></span><h4 class="subsection">2.1.7 <code>cpt-list</code></h4> +<span id="Updating-packages-1"></span><h4 class="subsection">1.2.2 Updating packages</h4> -<p>When called without arguments, <code>cpt-list</code> will print all installed -packages. You can add package names as arguments to check whether they are -installed or not. In success, <code>cpt-list</code> will exit with status 0 if all -given packages are installed, it will return 1 if any of the given packages -aren’t installed. +<p>It is good practice to make sure your system is up to date, especially before +building new packages. If there is an update for the package manager you will +need to update twice. </p> - +<div class="example"> +<pre class="example">cpt-update && cpt-update +</pre></div> diff --git a/docs/docs/Usage.html b/docs/docs/Usage.html deleted file mode 100644 index 65ade0d..0000000 --- a/docs/docs/Usage.html +++ /dev/null @@ -1,138 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Usage (Carbs Linux User Manual)</title> - -<meta name="description" content="Usage (Carbs Linux User Manual)"> -<meta name="keywords" content="Usage (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="cpt_002dalternatives.html" rel="next" title="cpt-alternatives"> -<link href="Package-Manager.html" rel="prev" title="Package Manager"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Usage"></span><div class="header"> -<p> -Next: <a href="Environment-Variables.html" accesskey="n" rel="next">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Usage-1"></span><h3 class="section">2.1 Usage</h3> - -<p><code>cpt</code> is formed of many tools combined in a single environment, similar -to <code>git</code>. When you run <code>cpt</code> without any arguments, it will show -all available tools and their explanations. Here is an example call with extra -scripts on my system: -</p> -<div class="example"> -<pre class="example">-> Carbs Packaging Tool --> add Commit the current directory as a new package --> alternatives List and swap to alternatives --> build Build a package --> bump Commit the current directory as a version bump --> cargo-urlgen Create static cargo sources for Rust packages --> cargolock-urlgen Convert the given Cargo.lock file to sources --> cat Concatanate package files in the installed package database --> changelog Print the git log of the specific package --> chbuild Create/destroy temporary chroots --> checkmissing Verify package manifests --> checksum Generate checksums --> chroot Enter a chroot --> commit Commit a package without the prefix of 'package:' --> depends Display a package's dependencies --> download Download sources for the given package --> exec Execute a command inside the alternatives system --> export Turn an installed package into a CPT tarball --> fetch Fetch repositories --> fork Fork a package to the current directory --> getchoice Prints the full path to a file in the alternatives system. --> install Install a package --> link Link a forked package's files to the other repository --> list List installed packages --> maintainer Find the maintainer of a package --> manifest Display all files owned by a package --> manifest-tree Display all files owned by a package with a tree view --> new Create a boilerplate CPT package --> orphans List orphaned packages --> owns Check which package owns a file --> rel Bump the release number of a package --> remove Remove a package --> repodepends Display a package's dependencies in the repository --> reporevdepends Display packages on the repository which depend on package --> reset Remove all packages except for the base --> revdepends Display packages which depend on package --> search Search for a package --> size Show the size on disk for a package --> source Extract sources of a given package to the current directory --> update Check for updates -</pre></div> - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="cpt_002dalternatives.html" accesskey="1"><code>cpt-alternatives</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dbuild.html" accesskey="2"><code>cpt-build</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dchecksum.html" accesskey="3"><code>cpt-checksum</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002ddownload.html" accesskey="4"><code>cpt-download</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dfetch.html" accesskey="5"><code>cpt-fetch</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dinstall.html" accesskey="6"><code>cpt-install</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dlist.html" accesskey="7"><code>cpt-list</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dremove.html" accesskey="8"><code>cpt-remove</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dsearch.html" accesskey="9"><code>cpt-search</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dupdate.html"><code>cpt-update</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Environment-Variables.html" accesskey="n" rel="next">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/docs/docs/cpt_002dfetch.html b/docs/docs/_002fetc_002finit_002frcconf-file.html index 0b5c840..5f33c04 100644 --- a/docs/docs/cpt_002dfetch.html +++ b/docs/docs/_002fetc_002finit_002frcconf-file.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-fetch (Carbs Linux User Manual)</title> +<title>/etc/init/rcconf file (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-fetch (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-fetch (Carbs Linux User Manual)"> +<meta name="description" content="/etc/init/rcconf file (Carbs Linux User Manual)"> +<meta name="keywords" content="/etc/init/rcconf file (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dinstall.html" rel="next" title="cpt-install"> -<link href="cpt_002ddownload.html" rel="prev" title="cpt-download"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> +<link href="Init-Hooks.html" rel="next" title="Init Hooks"> +<link href="Kernel-Command-Line.html" rel="prev" title="Kernel Command Line"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,19 +47,20 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dfetch"></span><div class="header"> +<span id="g_t_002fetc_002finit_002frcconf-file"></span><div class="header"> <p> -Next: <a href="cpt_002dinstall.html" accesskey="n" rel="next"><code>cpt-install</code></a>, Previous: <a href="cpt_002ddownload.html" accesskey="p" rel="prev"><code>cpt-download</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Init-Hooks.html" accesskey="n" rel="next">Init Hooks</a>, Previous: <a href="Kernel-Command-Line.html" accesskey="p" rel="prev">Kernel Command Line</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dfetch-1"></span><h4 class="subsection">2.1.5 <code>cpt-fetch</code></h4> +<span id="g_t_002fetc_002finit_002frc_002econf-file"></span><h4 class="subsection">2.1.2 ‘<samp>/etc/init/rc.conf</samp>’ file</h4> -<p><code>cpt-fetch</code> will fetch remote repositories. +<p>However, the kernel command line isn’t the only place to set your boot +parameters. You can specify variables here as well, although note that the +kernel command line always gets the priority for these variables since they can +be set just before boot. </p> - - </body> </html> diff --git a/docs/docs/cpt_002dupdate.html b/docs/docs/cpt_002dupdate.html deleted file mode 100644 index 7446855..0000000 --- a/docs/docs/cpt_002dupdate.html +++ /dev/null @@ -1,83 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-update (Carbs Linux User Manual)</title> - -<meta name="description" content="cpt-update (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-update (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="Environment-Variables.html" rel="next" title="Environment Variables"> -<link href="cpt_002dsearch.html" rel="prev" title="cpt-search"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="cpt_002dupdate"></span><div class="header"> -<p> -Previous: <a href="cpt_002dsearch.html" accesskey="p" rel="prev"><code>cpt-search</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="cpt_002dupdate-1"></span><h4 class="subsection">2.1.10 <code>cpt-update</code></h4> - -<p><code>cpt-update</code> will update the packages on your system. -</p> - - -<span id="Options-4"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-d --download</samp></dt> -<dd><p>Only download updatable packages. -</p></dd> -<dt><samp>-n --no-fetch</samp></dt> -<dd><p>Do not fetch remote repositories. -</p></dd> -<dt><samp>-y --no-prompt</samp></dt> -<dd><p>Do not prompt for confirmation. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Use an alternate root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - - - - - -</body> -</html> diff --git a/docs/docs/index.html b/docs/docs/index.html index 9511f59..68cef39 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -49,19 +50,6 @@ ul.no-bullet {list-style: none} -<span id="SEC_Overview"></span> -<h2 class="shortcontents-heading">Short Table of Contents</h2> - -<div class="shortcontents"> -<ul class="no-bullet"> -<li><a id="stoc-Installation-1" href="#toc-Installation-1">1 Installation</a></li> -<li><a id="stoc-Package-Manager-1" href="#toc-Package-Manager-1">2 Package Manager</a></li> -<li><a id="stoc-Init-System-1" href="#toc-Init-System-1">3 Init System</a></li> -<li><a id="stoc-Contribution-Guidelines-1" href="#toc-Contribution-Guidelines-1">4 Contribution Guidelines</a></li> -<li><a id="stoc-GNU-Free-Documentation-License-1" href="#toc-GNU-Free-Documentation-License-1">GNU Free Documentation License</a></li> -</ul> -</div> - <span id="SEC_Contents"></span> <h2 class="contents-heading">Table of Contents</h2> @@ -72,130 +60,70 @@ ul.no-bullet {list-style: none} <ul class="no-bullet"> <li><a id="toc-Preparing-Environment-1" href="Preparing-Environment.html#Preparing-Environment">1.1 Preparing Environment</a> <ul class="no-bullet"> - <li><a id="toc-Download" href="Preparing-Environment.html#Download">1.1.1 Download</a></li> - <li><a id="toc-Check-the-integrity-of-the-tarball-_0028Recommended_0029" href="Preparing-Environment.html#Check-the-integrity-of-the-tarball-_0028Recommended_0029">1.1.2 Check the integrity of the tarball (Recommended)</a></li> - <li><a id="toc-Verify-the-signature" href="Preparing-Environment.html#Verify-the-signature">1.1.3 Verify the signature</a></li> - <li><a id="toc-Extracting-the-tarball" href="Preparing-Environment.html#Extracting-the-tarball">1.1.4 Extracting the tarball</a></li> - <li><a id="toc-Obtain-the-chroot-helper" href="Preparing-Environment.html#Obtain-the-chroot-helper">1.1.5 Obtain the chroot helper</a></li> + <li><a id="toc-Download-1" href="Download.html#Download">1.1.1 Download</a></li> + <li><a id="toc-Signature-verification-1" href="Signature-verification.html#Signature-verification">1.1.2 Signature verification</a></li> + <li><a id="toc-Extracting-the-tarball-1" href="Extracting-the-tarball.html#Extracting-the-tarball">1.1.3 Extracting the tarball</a></li> + <li><a id="toc-Obtain-the-chroot-helper-1" href="Obtain-the-chroot-helper.html#Obtain-the-chroot-helper">1.1.4 Obtain the chroot helper</a></li> </ul></li> <li><a id="toc-Chroot-1" href="Chroot.html#Chroot">1.2 Chroot</a> <ul class="no-bullet"> - <li><a id="toc-Setting-up-repositories" href="Chroot.html#Setting-up-repositories">1.2.1 Setting up repositories</a> - <ul class="no-bullet"> - <li><a id="toc-Obtaining-from-rsync" href="Chroot.html#Obtaining-from-rsync">1.2.1.1 Obtaining from rsync</a></li> - <li><a id="toc-Obtaining-from-git" href="Chroot.html#Obtaining-from-git">1.2.1.2 Obtaining from git</a></li> - <li><a id="toc-Making-the-package-manager-use-the-repositories" href="Chroot.html#Making-the-package-manager-use-the-repositories">1.2.1.3 Making the package manager use the repositories</a></li> - </ul></li> - <li><a id="toc-Updating-packages" href="Chroot.html#Updating-packages">1.2.2 Updating packages</a></li> - <li><a id="toc-Installing-packages" href="Chroot.html#Installing-packages">1.2.3 Installing packages</a></li> - <li><a id="toc-Essential-Software" href="Chroot.html#Essential-Software">1.2.4 Essential Software</a></li> - <li><a id="toc-Obtaining-the-documentation-_0028optional_0029" href="Chroot.html#Obtaining-the-documentation-_0028optional_0029">1.2.5 Obtaining the documentation (optional)</a></li> + <li><a id="toc-Setting-up-repositories-1" href="Setting-up-repositories.html#Setting-up-repositories">1.2.1 Setting up repositories</a></li> + <li><a id="toc-Updating-packages-1" href="Updating-packages.html#Updating-packages">1.2.2 Updating packages</a></li> + <li><a id="toc-Installing-packages-1" href="Installing-packages.html#Installing-packages">1.2.3 Installing packages</a></li> + <li><a id="toc-Essential-Software-1" href="Essential-Software.html#Essential-Software">1.2.4 Essential Software</a></li> + <li><a id="toc-Obtaining-the-documentation-1" href="Obtaining-the-documentation.html#Obtaining-the-documentation">1.2.5 Obtaining the documentation</a></li> </ul></li> <li><a id="toc-System-Configuration-1" href="System-Configuration.html#System-Configuration">1.3 System Configuration</a> <ul class="no-bullet"> - <li><a id="toc-Configuring-hostname-_0028recommended_0029" href="System-Configuration.html#Configuring-hostname-_0028recommended_0029">1.3.1 Configuring hostname (recommended)</a></li> - <li><a id="toc-Setting-up-hosts-file-_0028optional_0029" href="System-Configuration.html#Setting-up-hosts-file-_0028optional_0029">1.3.2 Setting up hosts file (optional)</a></li> + <li><a id="toc-Configuring-hostname-1" href="Configuring-hostname.html#Configuring-hostname">1.3.1 Configuring hostname</a></li> + <li><a id="toc-Hosts-file-1" href="Hosts-file.html#Hosts-file">1.3.2 Hosts file</a></li> </ul></li> <li><a id="toc-Kernel-1" href="Kernel.html#Kernel">1.4 Kernel</a> <ul class="no-bullet"> - <li><a id="toc-Obtaining-the-kernel-sources" href="Kernel.html#Obtaining-the-kernel-sources">1.4.1 Obtaining the kernel sources</a></li> - <li><a id="toc-Installing-dependencies" href="Kernel.html#Installing-dependencies">1.4.2 Installing dependencies</a></li> - <li><a id="toc-Compiling-the-kernel" href="Kernel.html#Compiling-the-kernel">1.4.3 Compiling the kernel</a></li> + <li><a id="toc-Obtaining-the-kernel-sources-1" href="Obtaining-the-kernel-sources.html#Obtaining-the-kernel-sources">1.4.1 Obtaining the kernel sources</a></li> + <li><a id="toc-Kernel-dependencies-1" href="Kernel-dependencies.html#Kernel-dependencies">1.4.2 Kernel dependencies</a></li> + <li><a id="toc-Building-the-kernel-1" href="Building-the-kernel.html#Building-the-kernel">1.4.3 Building the kernel</a></li> </ul></li> <li><a id="toc-Making-your-system-bootable-1" href="Making-your-system-bootable.html#Making-your-system-bootable">1.5 Making your system bootable</a> <ul class="no-bullet"> - <li><a id="toc-Installing-a-bootloader" href="Making-your-system-bootable.html#Installing-a-bootloader">1.5.1 Installing a bootloader</a></li> - <li><a id="toc-Installing-init-scripts" href="Making-your-system-bootable.html#Installing-init-scripts">1.5.2 Installing init scripts</a></li> - <li><a id="toc-Generating-fstab" href="Making-your-system-bootable.html#Generating-fstab">1.5.3 Generating fstab</a></li> + <li><a id="toc-Bootloader-1" href="Bootloader.html#Bootloader">1.5.1 Bootloader</a></li> + <li><a id="toc-Init-scripts-1" href="Init-scripts.html#Init-scripts">1.5.2 Init scripts</a></li> + <li><a id="toc-Fstab-1" href="Fstab.html#Fstab">1.5.3 Fstab</a></li> </ul></li> <li><a id="toc-Post_002dinstallation-1" href="Post_002dinstallation.html#Post_002dinstallation">1.6 Post-installation</a> <ul class="no-bullet"> - <li><a id="toc-Acquiring-kiss-repositories" href="Post_002dinstallation.html#Acquiring-kiss-repositories">1.6.1 Acquiring kiss repositories</a></li> + <li><a id="toc-KISS-repositories-1" href="KISS-repositories.html#KISS-repositories">1.6.1 KISS repositories</a></li> </ul></li> </ul></li> - <li><a id="toc-Package-Manager-1" href="Package-Manager.html#Package-Manager">2 Package Manager</a> + <li><a id="toc-Init-System-1" href="Init-System.html#Init-System">2 Init System</a> <ul class="no-bullet"> - <li><a id="toc-Usage-1" href="Usage.html#Usage">2.1 Usage</a> - <ul class="no-bullet"> - <li><a id="toc-cpt_002dalternatives-1" href="cpt_002dalternatives.html#cpt_002dalternatives">2.1.1 <code>cpt-alternatives</code></a> - <ul class="no-bullet"> - <li><a id="toc-Examples" href="cpt_002dalternatives.html#Examples">Examples</a></li> - </ul></li> - <li><a id="toc-cpt_002dbuild-1" href="cpt_002dbuild.html#cpt_002dbuild">2.1.2 <code>cpt-build</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options" href="cpt_002dbuild.html#Options">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dchecksum-1" href="cpt_002dchecksum.html#cpt_002dchecksum">2.1.3 <code>cpt-checksum</code></a></li> - <li><a id="toc-cpt_002ddownload-1" href="cpt_002ddownload.html#cpt_002ddownload">2.1.4 <code>cpt-download</code></a></li> - <li><a id="toc-cpt_002dfetch-1" href="cpt_002dfetch.html#cpt_002dfetch">2.1.5 <code>cpt-fetch</code></a></li> - <li><a id="toc-cpt_002dinstall-1" href="cpt_002dinstall.html#cpt_002dinstall">2.1.6 <code>cpt-install</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-1" href="cpt_002dinstall.html#Options-1">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dlist-1" href="cpt_002dlist.html#cpt_002dlist">2.1.7 <code>cpt-list</code></a></li> - <li><a id="toc-cpt_002dremove-1" href="cpt_002dremove.html#cpt_002dremove">2.1.8 <code>cpt-remove</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-2" href="cpt_002dremove.html#Options-2">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dsearch-1" href="cpt_002dsearch.html#cpt_002dsearch">2.1.9 <code>cpt-search</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-3" href="cpt_002dsearch.html#Options-3">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dupdate-1" href="cpt_002dupdate.html#cpt_002dupdate">2.1.10 <code>cpt-update</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-4" href="cpt_002dupdate.html#Options-4">Options</a></li> - </ul></li> - </ul></li> - <li><a id="toc-Environment-Variables-1" href="Environment-Variables.html#Environment-Variables">2.2 Environment Variables</a></li> - <li><a id="toc-Hooks-1" href="Hooks.html#Hooks">2.3 Hooks</a> + <li><a id="toc-Configuring-Init-1" href="Configuring-Init.html#Configuring-Init">2.1 Configuring Init</a> <ul class="no-bullet"> - <li><a id="toc-Editing-the-build-file-during-pre_002dbuild-1" href="Editing-the-build-file-during-pre_002dbuild.html#Editing-the-build-file-during-pre_002dbuild">2.3.1 Editing the <samp>build</samp> file during pre-build</a></li> + <li><a id="toc-Kernel-Command-Line-1" href="Kernel-Command-Line.html#Kernel-Command-Line">2.1.1 Kernel Command Line</a></li> + <li><a id="toc-_002fetc_002finit_002frc_002econf-file" href="_002fetc_002finit_002frcconf-file.html#g_t_002fetc_002finit_002frcconf-file">2.1.2 ‘<samp>/etc/init/rc.conf</samp>’ file</a></li> + <li><a id="toc-Init-Hooks-1" href="Init-Hooks.html#Init-Hooks">2.1.3 Init Hooks</a></li> </ul></li> - <li><a id="toc-Packaging-System-1" href="Packaging-System.html#Packaging-System">2.4 Packaging System</a> + <li><a id="toc-Changing-Init-Program-1" href="Changing-Init-Program.html#Changing-Init-Program">2.2 Changing Init Program</a> <ul class="no-bullet"> - <li><a id="toc-build" href="Packaging-System.html#build">2.4.1 <samp>build</samp></a></li> - <li><a id="toc-sources" href="Packaging-System.html#sources">2.4.2 <samp>sources</samp></a></li> - <li><a id="toc-checksums" href="Packaging-System.html#checksums">2.4.3 <samp>checksums</samp></a></li> - <li><a id="toc-version" href="Packaging-System.html#version">2.4.4 <samp>version</samp></a></li> - <li><a id="toc-depends" href="Packaging-System.html#depends">2.4.5 <samp>depends</samp></a></li> - <li><a id="toc-post_002dinstall" href="Packaging-System.html#post_002dinstall">2.4.6 <samp>post-install</samp></a></li> - <li><a id="toc-message" href="Packaging-System.html#message">2.4.7 <samp>message</samp></a></li> - <li><a id="toc-test" href="Packaging-System.html#test">2.4.8 <samp>test</samp></a></li> - </ul></li> - <li><a id="toc-Rsync-Repositories-1" href="Rsync-Repositories.html#Rsync-Repositories">2.5 Rsync Repositories</a> - <ul class="no-bullet"> - <li><a id="toc-Setting-up-an-rsync-repository-for-distribution-1" href="Setting-up-an-rsync-repository-for-distribution.html#Setting-up-an-rsync-repository-for-distribution">2.5.1 Setting up an rsync repository for distribution</a></li> + <li><a id="toc-Rebooting-after-changing-init-1" href="Rebooting-after-changing-init.html#Rebooting-after-changing-init">2.2.1 Rebooting after changing init</a></li> </ul></li> </ul></li> - <li><a id="toc-Init-System-1" href="Init-System.html#Init-System">3 Init System</a> + <li><a id="toc-Contribution-Guidelines-1" href="Contribution-Guidelines.html#Contribution-Guidelines">3 Contribution Guidelines</a> <ul class="no-bullet"> - <li><a id="toc-Configuring-Init-1" href="Configuring-Init.html#Configuring-Init">3.1 Configuring Init</a> - <ul class="no-bullet"> - <li><a id="toc-Kernel-Command-Line" href="Configuring-Init.html#Kernel-Command-Line">3.1.1 Kernel Command Line</a></li> - <li><a id="toc-_002fetc_002finit_002frc_002econf-file" href="Configuring-Init.html#g_t_002fetc_002finit_002frc_002econf-file">3.1.2 <samp>/etc/init/rc.conf</samp> file</a></li> - </ul></li> - <li><a id="toc-Init-Hooks-1" href="Init-Hooks.html#Init-Hooks">3.2 Init Hooks</a></li> - <li><a id="toc-Changing-Init-Program-1" href="Changing-Init-Program.html#Changing-Init-Program">3.3 Changing Init Program</a> + <li><a id="toc-Conventions-1" href="Conventions.html#Conventions">3.1 Conventions</a> <ul class="no-bullet"> - <li><a id="toc-Rebooting-after-changing-Init" href="Changing-Init-Program.html#Rebooting-after-changing-Init">3.3.1 Rebooting after changing Init</a></li> + <li><a id="toc-Shell-Conventions-1" href="Shell-Conventions.html#Shell-Conventions">3.1.1 Shell Conventions</a></li> + <li><a id="toc-Repository-Conventions-1" href="Repository-Conventions.html#Repository-Conventions">3.1.2 Repository Conventions</a></li> </ul></li> </ul></li> - <li><a id="toc-Contribution-Guidelines-1" href="Contribution-Guidelines.html#Contribution-Guidelines">4 Contribution Guidelines</a> + <li><a id="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a> <ul class="no-bullet"> - <li><a id="toc-Conventions-1" href="Conventions.html#Conventions">4.1 Conventions</a> - <ul class="no-bullet"> - <li><a id="toc-General-Conventions-_002d_002d-00" href="General-Conventions.html#General-Conventions">4.1.1 General Conventions – 00</a></li> - <li><a id="toc-Shell-Conventions-_002d_002d-10" href="Shell-Conventions.html#Shell-Conventions">4.1.2 Shell Conventions – 10</a></li> - <li><a id="toc-Repository-Conventions-_002d_002d-20" href="Repository-Conventions.html#Repository-Conventions">4.1.3 Repository Conventions – 20</a></li> - </ul></li> - <li><a id="toc-Sending-Git-mails-1" href="Sending-Git-mails.html#Sending-Git-mails">4.2 Sending Git mails</a></li> + <li><a id="toc-ADDENDUM_003a-How-to-use-this-License-for-your-documents" href="GNU-Free-Documentation-License.html#ADDENDUM_003a-How-to-use-this-License-for-your-documents">A.1 ADDENDUM: How to use this License for your documents</a></li> </ul></li> - <li><a id="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU Free Documentation License</a></li> </ul> </div> - <span id="Top"></span><div class="header"> <p> Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> @@ -203,9 +131,8 @@ Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> &nbs <hr> <span id="Carbs-Linux-User-Manual"></span><h1 class="top">Carbs Linux User Manual</h1> -<p>This is the full documentation of <a href="https://carbslinux.org">Carbs Linux</a>, -from the details of the distribution, installation, to the package manager. It -is not yet complete. +<p>This is the full documentation of <a href="https://carbslinux.org">Carbs Linux</a>, from the details of the +distribution, installation, to the package manager. It is not yet complete. </p> <p>This documentation is also available in the distribution by the @@ -214,53 +141,92 @@ is not yet complete. favorite pager. You can install either the <code>info</code> or <code>texinfo</code> for doing the first. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Installation.html" accesskey="1">Installation</a></td><td> </td><td align="left" valign="top">Installing Carbs Linux +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-System.html" accesskey="2">Init System</a></td><td> </td><td align="left" valign="top">Configure the init system +</td></tr> +<tr><td align="left" valign="top">• <a href="Contribution-Guidelines.html" accesskey="3">Contribution Guidelines</a></td><td> </td><td align="left" valign="top">Contribute to Carbs Linux +</td></tr> +<tr><td align="left" valign="top">• <a href="GNU-Free-Documentation-License.html" accesskey="4">GNU Free Documentation License</a></td><td> </td><td align="left" valign="top">Your rights +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">— The Detailed Node Listing — +Installation -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Installation.html" accesskey="1">Installation</a></td><td> </td><td align="left" valign="top">Installing Carbs Linux +</pre></th></tr><tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="5">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot +</td></tr> +<tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="6">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system </td></tr> -<tr><td align="left" valign="top">• <a href="Package-Manager.html" accesskey="2">Package Manager</a></td><td> </td><td align="left" valign="top">Carbs Linux Packaging Tools +<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="7">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing your system for personal use </td></tr> -<tr><td align="left" valign="top">• <a href="Init-System.html" accesskey="3">Init System</a></td><td> </td><td align="left" valign="top">Configuring the init system +<tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="8">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Contribution-Guidelines.html" accesskey="4">Contribution Guidelines</a></td><td> </td><td align="left" valign="top">Contributing to Carbs Linux +<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="9">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing bootloader and boot scripts </td></tr> -<tr><td align="left" valign="top">• <a href="GNU-Free-Documentation-License.html" accesskey="5">GNU Free Documentation License</a></td><td> </td><td align="left" valign="top">Copying Conditions +<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html">Post-installation</a></td><td> </td><td align="left" valign="top">Post-installation tasks </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +Preparing Environment -— Detailed Menu Listing — +</pre></th></tr><tr><td align="left" valign="top">• <a href="Download.html">Download</a></td><td> </td><td align="left" valign="top">Download the root filesystem tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Signature-verification.html">Signature verification</a></td><td> </td><td align="left" valign="top">Verify the signature of the rootfs tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Extracting-the-tarball.html">Extracting the tarball</a></td><td> </td><td align="left" valign="top">Extracting the root filesystem to the desired location +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtain-the-chroot-helper.html">Obtain the chroot helper</a></td><td> </td><td align="left" valign="top">Download the script to easily chroot into the new filesystem +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -Installation +Chroot -</pre></th></tr><tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="6">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot +</pre></th></tr><tr><td align="left" valign="top">• <a href="Setting-up-repositories.html">Setting up repositories</a></td><td> </td><td align="left" valign="top">Basic setup for obtaining repositories +</td></tr> +<tr><td align="left" valign="top">• <a href="Updating-packages.html">Updating packages</a></td><td> </td><td align="left" valign="top">Update your system </td></tr> -<tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="7">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system +<tr><td align="left" valign="top">• <a href="Installing-packages.html">Installing packages</a></td><td> </td><td align="left" valign="top">Install new software on your system </td></tr> -<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="8">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing for your personal use +<tr><td align="left" valign="top">• <a href="Essential-Software.html">Essential Software</a></td><td> </td><td align="left" valign="top">Software you might want to include on your system </td></tr> -<tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="9">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel +<tr><td align="left" valign="top">• <a href="Obtaining-the-documentation.html">Obtaining the documentation</a></td><td> </td><td align="left" valign="top">Install documentation for offline use (optional) </td></tr> -<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing init and bootloader +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +System Configuration + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Configuring-hostname.html">Configuring hostname</a></td><td> </td><td align="left" valign="top">Setting up system hostname (recommended) </td></tr> -<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html">Post-installation</a></td><td> </td><td align="left" valign="top">Acquiring more packages and repositories +<tr><td align="left" valign="top">• <a href="Hosts-file.html">Hosts file</a></td><td> </td><td align="left" valign="top">Setting up hosts file for networking (optional) </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -Package Manager +Kernel -</pre></th></tr><tr><td align="left" valign="top">• <a href="Usage.html">Usage</a></td><td> </td><td align="left" valign="top">Using Carbs Packaging Tools +</pre></th></tr><tr><td align="left" valign="top">• <a href="Obtaining-the-kernel-sources.html">Obtaining the kernel sources</a></td><td> </td><td align="left" valign="top">Downloading the Linux source code </td></tr> -<tr><td align="left" valign="top">• <a href="Environment-Variables.html">Environment Variables</a></td><td> </td><td align="left" valign="top">Values that affect the operation of CPT +<tr><td align="left" valign="top">• <a href="Kernel-dependencies.html">Kernel dependencies</a></td><td> </td><td align="left" valign="top">Requirements for building the kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Hooks.html">Hooks</a></td><td> </td><td align="left" valign="top">Using hooks to customize the package manager operations +<tr><td align="left" valign="top">• <a href="Building-the-kernel.html">Building the kernel</a></td><td> </td><td align="left" valign="top">Configure and compile the kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Packaging-System.html">Packaging System</a></td><td> </td><td align="left" valign="top">More detail on creating packages +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Making your system bootable + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Bootloader.html">Bootloader</a></td><td> </td><td align="left" valign="top">Install a bootloader for your system </td></tr> -<tr><td align="left" valign="top">• <a href="Rsync-Repositories.html">Rsync Repositories</a></td><td> </td><td align="left" valign="top">Information on using or creating rsync repositories +<tr><td align="left" valign="top">• <a href="Init-scripts.html">Init scripts</a></td><td> </td><td align="left" valign="top">Install init scripts for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Fstab.html">Fstab</a></td><td> </td><td align="left" valign="top">Generating fstab +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Post-installation + +</pre></th></tr><tr><td align="left" valign="top">• <a href="KISS-repositories.html">KISS repositories</a></td><td> </td><td align="left" valign="top">Acquire kiss repositories </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> @@ -268,15 +234,41 @@ Init System </pre></th></tr><tr><td align="left" valign="top">• <a href="Configuring-Init.html">Configuring Init</a></td><td> </td><td align="left" valign="top">Ways to configure the init system </td></tr> -<tr><td align="left" valign="top">• <a href="Init-Hooks.html">Init Hooks</a></td><td> </td><td align="left" valign="top">Adding your personal commands to the init system +<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replace the default busybox init with something new </td></tr> -<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replacing the default busybox init with something new +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Configuring Init + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Kernel-Command-Line.html">Kernel Command Line</a></td><td> </td><td align="left" valign="top">Configure init through the boot parameters +</td></tr> +<tr><td align="left" valign="top">• <a href="_002fetc_002finit_002frcconf-file.html">‘<samp>/etc/init/rc.conf</samp>’ file</a></td><td> </td><td align="left" valign="top">Configure init through the configuration file +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-Hooks.html">Init Hooks</a></td><td> </td><td align="left" valign="top">Configure init through hooks +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Changing Init Program + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Rebooting-after-changing-init.html">Rebooting after changing init</a></td><td> </td><td align="left" valign="top">Ways to reboot after replacing the init system </td></tr> -</table> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Contribution Guidelines +</pre></th></tr><tr><td align="left" valign="top">• <a href="Conventions.html">Conventions</a></td><td> </td><td align="left" valign="top">Conventions of the distribution +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +Conventions +</pre></th></tr><tr><td align="left" valign="top">• <a href="Shell-Conventions.html">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts +</td></tr> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr></table> <hr> <div class="header"> diff --git a/docs/docs/install.html b/docs/docs/install.html index 6ed93a7..176aacd 100644 --- a/docs/docs/install.html +++ b/docs/docs/install.html @@ -1,393 +1,822 @@ -<!DOCTYPE HTML> -<html lan=en> - <head> - <title>install | Carbs Linux</title> - <link rel="stylesheet" href="/style.css"> - <meta charset="utf-8"> - <meta name="Description" content="Carbs Linux - a simple linux distribution"> - <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> - </head> - <body> - <p class=header><strong>Carbs Linux - a simple linux distribution</strong></p> - <div class="header"> - <nav> - <a href='/'>index</a> - <a href="//git.carbslinux.org">git</a> - <a href='//dl.carbslinux.org'>downloads</a> - <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> - <a href='/docs'>user manual</a> - </nav> - </div><div class="border"></div> -<pre> -1 Installation -************** - -These are the step-by-step instructions for installing Carbs Linux. - -1.1 Preparing Environment -========================= - -To install Carbs Linux, you will need a Live Linux ISO. For that -purpose, you can obtain a Gentoo or Void Linux live image. You can -follow their instructions to boot and setup your network. - - You will need the following programs in order to install Carbs Linux: - - * tar - * wget - * xz - * some form of base utilities (coreutils, sbase, busybox, etc.) - - Rest of these instructions will assume that you have set all of these -up, and will continue on that point. - -1.1.1 Download --------------- - -First, we need to download the rootfs tarball. You can do the following -in order to obtain the rootfs. If you are using an i686 machine, -replace the 'x86_64' with 'i686'. We are setting this in a URL variable -so that we don't have to write it every time. - - $ URL=<a href=https://dl.carbslinux.org/releases/x86_64>https://dl.carbslinux.org/releases/x86_64</a> - $ wget $URL/carbs-rootfs.tar.xz - - We can then check the integrity of the tarball and do a signature -verification. Even thought these are optional, they are highly -recommended. - -1.1.2 Check the integrity of the tarball (Recommended) ------------------------------------------------------- - -All of the releases are saved in a single file named 'sha256sums.txt', -but the latest release is saved on 'carbs-rootfs.tar.xz.sha256'. You -can acquire and verify the tarball. - - $ wget $URL/carbs-rootfs.tar.xz.sha256 - $ sha256sum -c carbs-rootfs.tar.xz.sha256 - -1.1.3 Verify the signature --------------------------- - -It is highly recommended to verify the signature of the tarball. You -will need GPG for this. - - $ wget $URL/carbs-rootfs.tar.xz.sig - $ gpg --recv-keys FF484BDFEFCEF8FF - $ gpg --verify carbs-rootfs.tar.xz.sig - -1.1.4 Extracting the tarball ----------------------------- - -You will need to extract the tarball to your desired location. For -partitioning, you can follow this guide -(<a href=https://wiki.archlinux.org/index.php/Partitioning>https://wiki.archlinux.org/index.php/Partitioning</a>). This will assume -that you will be mounting your root partition to '/mnt'. - - $ mount /dev/sdx1 /mnt - $ tar xf carbs-rootfs.tar.xz -C /mnt - -1.1.5 Obtain the chroot helper ------------------------------- - -You can obtain the 'cpt-chroot' script in order to do a simple chroot -into your new root filesystem. - - $ wget <a href=https://dl.carbslinux.org/distfiles/cpt-chroot>https://dl.carbslinux.org/distfiles/cpt-chroot</a> - $ chmod a+x cpt-chroot - -1.2 Chroot -========== - +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> +<head> +<!-- 2020-12-26 Sat 03:17 --> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<meta name="viewport" content="width=device-width, initial-scale=1" /> +<title>Carbs Linux Installation Guide</title> +<meta name="generator" content="Org mode" /> +<meta name="author" content="Cem Keylan" /> +<style type="text/css"> + <!--/*--><![CDATA[/*><!--*/ + .title { text-align: center; + margin-bottom: .2em; } + .subtitle { text-align: center; + font-size: medium; + font-weight: bold; + margin-top:0; } + .todo { font-family: monospace; color: red; } + .done { font-family: monospace; color: green; } + .priority { font-family: monospace; color: orange; } + .tag { background-color: #eee; font-family: monospace; + padding: 2px; font-size: 80%; font-weight: normal; } + .timestamp { color: #bebebe; } + .timestamp-kwd { color: #5f9ea0; } + .org-right { margin-left: auto; margin-right: 0px; text-align: right; } + .org-left { margin-left: 0px; margin-right: auto; text-align: left; } + .org-center { margin-left: auto; margin-right: auto; text-align: center; } + .underline { text-decoration: underline; } + #postamble p, #preamble p { font-size: 90%; margin: .2em; } + p.verse { margin-left: 3%; } + pre { + border: 1px solid #ccc; + box-shadow: 3px 3px 3px #eee; + padding: 8pt; + font-family: monospace; + overflow: auto; + margin: 1.2em; + } + pre.src { + position: relative; + overflow: visible; + padding-top: 1.2em; + } + pre.src:before { + display: none; + position: absolute; + background-color: white; + top: -10px; + right: 10px; + padding: 3px; + border: 1px solid black; + } + pre.src:hover:before { display: inline;} + /* Languages per Org manual */ + pre.src-asymptote:before { content: 'Asymptote'; } + pre.src-awk:before { content: 'Awk'; } + pre.src-C:before { content: 'C'; } + /* pre.src-C++ doesn't work in CSS */ + pre.src-clojure:before { content: 'Clojure'; } + pre.src-css:before { content: 'CSS'; } + pre.src-D:before { content: 'D'; } + pre.src-ditaa:before { content: 'ditaa'; } + pre.src-dot:before { content: 'Graphviz'; } + pre.src-calc:before { content: 'Emacs Calc'; } + pre.src-emacs-lisp:before { content: 'Emacs Lisp'; } + pre.src-fortran:before { content: 'Fortran'; } + pre.src-gnuplot:before { content: 'gnuplot'; } + pre.src-haskell:before { content: 'Haskell'; } + pre.src-hledger:before { content: 'hledger'; } + pre.src-java:before { content: 'Java'; } + pre.src-js:before { content: 'Javascript'; } + pre.src-latex:before { content: 'LaTeX'; } + pre.src-ledger:before { content: 'Ledger'; } + pre.src-lisp:before { content: 'Lisp'; } + pre.src-lilypond:before { content: 'Lilypond'; } + pre.src-lua:before { content: 'Lua'; } + pre.src-matlab:before { content: 'MATLAB'; } + pre.src-mscgen:before { content: 'Mscgen'; } + pre.src-ocaml:before { content: 'Objective Caml'; } + pre.src-octave:before { content: 'Octave'; } + pre.src-org:before { content: 'Org mode'; } + pre.src-oz:before { content: 'OZ'; } + pre.src-plantuml:before { content: 'Plantuml'; } + pre.src-processing:before { content: 'Processing.js'; } + pre.src-python:before { content: 'Python'; } + pre.src-R:before { content: 'R'; } + pre.src-ruby:before { content: 'Ruby'; } + pre.src-sass:before { content: 'Sass'; } + pre.src-scheme:before { content: 'Scheme'; } + pre.src-screen:before { content: 'Gnu Screen'; } + pre.src-sed:before { content: 'Sed'; } + pre.src-sh:before { content: 'shell'; } + pre.src-sql:before { content: 'SQL'; } + pre.src-sqlite:before { content: 'SQLite'; } + /* additional languages in org.el's org-babel-load-languages alist */ + pre.src-forth:before { content: 'Forth'; } + pre.src-io:before { content: 'IO'; } + pre.src-J:before { content: 'J'; } + pre.src-makefile:before { content: 'Makefile'; } + pre.src-maxima:before { content: 'Maxima'; } + pre.src-perl:before { content: 'Perl'; } + pre.src-picolisp:before { content: 'Pico Lisp'; } + pre.src-scala:before { content: 'Scala'; } + pre.src-shell:before { content: 'Shell Script'; } + pre.src-ebnf2ps:before { content: 'ebfn2ps'; } + /* additional language identifiers per "defun org-babel-execute" + in ob-*.el */ + pre.src-cpp:before { content: 'C++'; } + pre.src-abc:before { content: 'ABC'; } + pre.src-coq:before { content: 'Coq'; } + pre.src-groovy:before { content: 'Groovy'; } + /* additional language identifiers from org-babel-shell-names in + ob-shell.el: ob-shell is the only babel language using a lambda to put + the execution function name together. */ + pre.src-bash:before { content: 'bash'; } + pre.src-csh:before { content: 'csh'; } + pre.src-ash:before { content: 'ash'; } + pre.src-dash:before { content: 'dash'; } + pre.src-ksh:before { content: 'ksh'; } + pre.src-mksh:before { content: 'mksh'; } + pre.src-posh:before { content: 'posh'; } + /* Additional Emacs modes also supported by the LaTeX listings package */ + pre.src-ada:before { content: 'Ada'; } + pre.src-asm:before { content: 'Assembler'; } + pre.src-caml:before { content: 'Caml'; } + pre.src-delphi:before { content: 'Delphi'; } + pre.src-html:before { content: 'HTML'; } + pre.src-idl:before { content: 'IDL'; } + pre.src-mercury:before { content: 'Mercury'; } + pre.src-metapost:before { content: 'MetaPost'; } + pre.src-modula-2:before { content: 'Modula-2'; } + pre.src-pascal:before { content: 'Pascal'; } + pre.src-ps:before { content: 'PostScript'; } + pre.src-prolog:before { content: 'Prolog'; } + pre.src-simula:before { content: 'Simula'; } + pre.src-tcl:before { content: 'tcl'; } + pre.src-tex:before { content: 'TeX'; } + pre.src-plain-tex:before { content: 'Plain TeX'; } + pre.src-verilog:before { content: 'Verilog'; } + pre.src-vhdl:before { content: 'VHDL'; } + pre.src-xml:before { content: 'XML'; } + pre.src-nxml:before { content: 'XML'; } + /* add a generic configuration mode; LaTeX export needs an additional + (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */ + pre.src-conf:before { content: 'Configuration File'; } + + table { border-collapse:collapse; } + caption.t-above { caption-side: top; } + caption.t-bottom { caption-side: bottom; } + td, th { vertical-align:top; } + th.org-right { text-align: center; } + th.org-left { text-align: center; } + th.org-center { text-align: center; } + td.org-right { text-align: right; } + td.org-left { text-align: left; } + td.org-center { text-align: center; } + dt { font-weight: bold; } + .footpara { display: inline; } + .footdef { margin-bottom: 1em; } + .figure { padding: 1em; } + .figure p { text-align: center; } + .equation-container { + display: table; + text-align: center; + width: 100%; + } + .equation { + vertical-align: middle; + } + .equation-label { + display: table-cell; + text-align: right; + vertical-align: middle; + } + .inlinetask { + padding: 10px; + border: 2px solid gray; + margin: 10px; + background: #ffffcc; + } + #org-div-home-and-up + { text-align: right; font-size: 70%; white-space: nowrap; } + textarea { overflow-x: auto; } + .linenr { font-size: smaller } + .code-highlighted { background-color: #ffff00; } + .org-info-js_info-navigation { border-style: none; } + #org-info-js_console-label + { font-size: 10px; font-weight: bold; white-space: nowrap; } + .org-info-js_search-highlight + { background-color: #ffff00; color: #000000; font-weight: bold; } + .org-svg { width: 90%; } + /*]]>*/--> +</style> +</head> +<body> +<div id="content"> +<h1 class="title">Carbs Linux Installation Guide</h1> +<div id="table-of-contents"> +<h2>Table of Contents</h2> +<div id="text-table-of-contents"> +<ul> +<li><a href="#orgf69e554">1. Preparing Environment</a> +<ul> +<li><a href="#org95a0e69">1.1. Download</a></li> +<li><a href="#org8e36ac6">1.2. Signature verification</a></li> +<li><a href="#orgea2754a">1.3. Extracting the tarball</a></li> +<li><a href="#org04cd78e">1.4. Obtain the chroot helper</a></li> +</ul> +</li> +<li><a href="#org75ac2b4">2. Chroot</a> +<ul> +<li><a href="#org8778be8">2.1. Setting up repositories</a> +<ul> +<li><a href="#orga965761">2.1.1. Obtaining from git</a></li> +<li><a href="#orgb7bea54">2.1.2. Obtaining from rsync</a></li> +<li><a href="#orgb72886d">2.1.3. Making the package manager use the repositories</a></li> +</ul> +</li> +<li><a href="#org2a9ee98">2.2. Updating packages</a></li> +<li><a href="#orgf04d2d5">2.3. Installing packages</a></li> +<li><a href="#orgb80a3a8">2.4. Essential Software</a></li> +<li><a href="#org1e0d5e0">2.5. Obtaining the documentation</a></li> +</ul> +</li> +<li><a href="#orgd61a283">3. System Configuration</a> +<ul> +<li><a href="#orgc097724">3.1. Configuring hostname</a></li> +<li><a href="#org88a7ef3">3.2. Hosts file</a></li> +</ul> +</li> +<li><a href="#org92806b4">4. Kernel</a> +<ul> +<li><a href="#orgb246a4d">4.1. Obtaining the kernel sources</a></li> +<li><a href="#orgf9a076f">4.2. Kernel dependencies</a></li> +<li><a href="#orga3c74bc">4.3. Building the kernel</a></li> +</ul> +</li> +<li><a href="#orgb176eb1">5. Making your system bootable</a> +<ul> +<li><a href="#org31a5fde">5.1. Bootloader</a> +<ul> +<li><a href="#org43ed898">5.1.1. GRUB BIOS installation</a></li> +<li><a href="#orgf826efe">5.1.2. GRUB UEFI installation</a></li> +</ul> +</li> +<li><a href="#org2d43b5f">5.2. Init scripts</a></li> +<li><a href="#orgfe8161b">5.3. Fstab</a></li> +</ul> +</li> +<li><a href="#org917e2c8">6. Post-installation</a> +<ul> +<li><a href="#org96641ac">6.1. KISS repositories</a></li> +</ul> +</li> +</ul> +</div> +</div> +<p> +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 +<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a>. +</p> + +<div id="outline-container-orgf69e554" class="outline-2"> +<h2 id="orgf69e554"><span class="section-number-2">1</span> Preparing Environment</h2> +<div class="outline-text-2" id="text-1"> +<p> +To install Carbs Linux, you will need a Live Linux ISO. For that purpose, you +can obtain a Gentoo or Void Linux live image. You can follow their instructions +to boot and setup your network. +</p> + +<p> +You will need the following programs in order to install Carbs Linux: +</p> + +<ul class="org-ul"> +<li>tar</li> +<li>wget</li> +<li>xz</li> +<li>some form of base utilities (coreutils, sbase, busybox, etc.)</li> +</ul> + +<p> +Rest of these instructions will assume that you have set all of these up, and +will continue on that point. +</p> +</div> + +<div id="outline-container-org95a0e69" class="outline-3"> +<h3 id="org95a0e69"><span class="section-number-3">1.1</span> Download</h3> +<div class="outline-text-3" id="text-1-1"> +<p> +First, we need to download the rootfs tarball. You can do the following in order +to obtain the rootfs. If you are using an i686 machine, replace the <code>x86_64</code> +with <code>i686</code>. We are setting this in a URL variable so that we don't have to +write it every time. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget $<span style="color: #8e44ad;">URL</span>/carbs-rootfs.tar.xz.sha256 +sha256sum -c carbs-rootfs.tar.xz.sha256 +</pre> +</div> +</div> +</div> + +<div id="outline-container-org8e36ac6" class="outline-3"> +<h3 id="org8e36ac6"><span class="section-number-3">1.2</span> Signature verification</h3> +<div class="outline-text-3" id="text-1-2"> +<p> +It is highly recommended to verify the signature of the tarball. You will need +GPG for this. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget $<span style="color: #8e44ad;">URL</span>/carbs-rootfs.tar.xz.sig +gpg --recv-keys FF484BDFEFCEF8FF +gpg --verify carbs-rootfs.tar.xz.sig +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgea2754a" class="outline-3"> +<h3 id="orgea2754a"><span class="section-number-3">1.3</span> Extracting the tarball</h3> +<div class="outline-text-3" id="text-1-3"> +<p> +You will need to extract the tarball to your desired location. For partitioning, +you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. This will assume that you will be mounting your root +partition to <code>/mnt</code>. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">mount /dev/sdx1 /mnt +tar xf carbs-rootfs.tar.xz -C /mnt +</pre> +</div> +</div> +</div> + +<div id="outline-container-org04cd78e" class="outline-3"> +<h3 id="org04cd78e"><span class="section-number-3">1.4</span> Obtain the chroot helper</h3> +<div class="outline-text-3" id="text-1-4"> +<p> +You can obtain the <code>cpt-chroot</code> script in order to do a simple chroot into your +new root filesystem. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://dl.carbslinux.org/distfiles/cpt-chroot +chmod a+x cpt-chroot +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org75ac2b4" class="outline-2"> +<h2 id="org75ac2b4"><span class="section-number-2">2</span> Chroot</h2> +<div class="outline-text-2" id="text-2"> +<p> Chroot into Carbs Linux! +</p> - $ ./cpt-chroot /mnt - -1.2.1 Setting up repositories ------------------------------ - -Newest tarballs do not come with repositories, so you will need to -manually obtain them, and set your 'CPT_PATH' environment variable. -Carbs Linux repositories can either be obtained by 'git' or 'rsync'. -While rsync repositories are overall faster and smaller, git offers the -whole history of the repository and a means to manipulate your -repository as you like it. If you want to obtain the git repository, -you will need to install 'git' itself. - - The following guide will assume that you put the repositories into -'~/repos/' directory, but you can put the repositories into any -directory you want. So go ahead and create that directory: - - $ mkdir -p $HOME/repos - -1.2.1.1 Obtaining from rsync -............................ - -Carbs Linux rsync repositories live in <rsync://carbslinux.org/repo>. -In order to obtain it, run the following: - - $ rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs - -1.2.1.2 Obtaining from git -.......................... - -Carbs Linux git repositories can be found both from the main server and -GitHub (mirror). Here are both their repository links. You can clone -any of them. - - * <git://git.carbslinux.org/repository> - * <<a href=https://github.com/carbslinux/repository>>https://github.com/carbslinux/repository></a> - - $ git clone git://git.carbslinux.org/repository $HOME/repos/carbs - -1.2.1.3 Making the package manager use the repositories -....................................................... - -In your shell's configuration file, or in your '~/.profile' file, add -the following lines: - - export CPT_PATH='' - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/core - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community - export CPT_PATH - -1.2.2 Updating packages ------------------------ - -It is good practice to make sure your system is up to date, especially -before building new packages. If there is an update for the package -manager you will need to update twice. - - $ cpt update - -1.2.3 Installing packages -------------------------- - -Since you are operating on a really small base, you might need to build -and install new programs to extend the functionality of your system. In -order to build and install packages new packages in Carbs, you need to -execute the following. "Package" is not actually a package and is given -as an example. - - $ cpt build package - $ cpt install package - -1.2.4 Essential Software ------------------------- - +<div class="org-src-container"> +<pre class="src src-sh">./cpt-chroot /mnt +</pre> +</div> +</div> + +<div id="outline-container-org8778be8" class="outline-3"> +<h3 id="org8778be8"><span class="section-number-3">2.1</span> Setting up repositories</h3> +<div class="outline-text-3" id="text-2-1"> +<p> +Newest tarballs do not come with repositories, so you will need to manually +obtain them, and set your <code>CPT_PATH</code> environment variable. Carbs Linux +repositories can either be obtained by <code>git</code> or <code>rsync</code>. While rsync +repositories are overall faster and smaller, git offers the whole history of the +repository and a means to manipulate your repository as you like it. If you want +to obtain the git repository, you will need to install <code>git</code> itself. +</p> + +<p> +The following guide will assume that you put the repositories into <code>~/repos/</code> +directory, but you can put the repositories into any directory you want. So go +ahead and create that directory: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">mkdir -p $<span style="color: #8e44ad;">HOME</span>/repos +</pre> +</div> +</div> + +<div id="outline-container-orga965761" class="outline-4"> +<h4 id="orga965761"><span class="section-number-4">2.1.1</span> Obtaining from git</h4> +<div class="outline-text-4" id="text-2-1-1"> +<p> +Carbs Linux git repositories can be found both from the main server and GitHub +(mirror). Here are both their repository links. You can clone any of them. +</p> + +<ul class="org-ul"> +<li>git://git.carbslinux.org/repository</li> +<li><a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a></li> +</ul> + +<div class="org-src-container"> +<pre class="src src-sh">git clone git://git.carbslinux.org/repository $<span style="color: #8e44ad;">HOME</span>/repos/carbs +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb7bea54" class="outline-4"> +<h4 id="orgb7bea54"><span class="section-number-4">2.1.2</span> Obtaining from rsync</h4> +<div class="outline-text-4" id="text-2-1-2"> +<p> +Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In +order to obtain it, run the following: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">rsync -avc rsync://carbslinux.org/repo $<span style="color: #8e44ad;">HOME</span>/repos/carbs +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb72886d" class="outline-4"> +<h4 id="orgb72886d"><span class="section-number-4">2.1.3</span> Making the package manager use the repositories</h4> +<div class="outline-text-4" id="text-2-1-3"> +<p> +In your shell's configuration file, or in your <code>~/.profile</code> file, add the +following lines: +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">HOME</span>/repos/carbs/core +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/extra +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/xorg +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/community +<span style="color: #16a085;">export</span> CPT_PATH +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org2a9ee98" class="outline-3"> +<h3 id="org2a9ee98"><span class="section-number-3">2.2</span> Updating packages</h3> +<div class="outline-text-3" id="text-2-2"> +<p> +It is good practice to make sure your system is up to date, especially before +building new packages. If there is an update for the package manager you will +need to update twice. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt-update && cpt-update +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf04d2d5" class="outline-3"> +<h3 id="orgf04d2d5"><span class="section-number-3">2.3</span> Installing packages</h3> +<div class="outline-text-3" id="text-2-3"> +<p> +Since you are operating on a really small base, you might need to build and +install new programs to extend the functionality of your system. In order to +build and install packages new packages in Carbs, you need to execute the +following. "Package" is not actually a package and is given as an example. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt-build package +cpt-install package +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb80a3a8" class="outline-3"> +<h3 id="orgb80a3a8"><span class="section-number-3">2.4</span> Essential Software</h3> +<div class="outline-text-3" id="text-2-4"> +<p> Here is a list of software that you might want to have on your system. - - BOOTLOADERS - * efibootmgr - * grub - FILESYSTEMS - * e2fsprogs - * dosfstools - * ntfs-3g - NETWORKING - * dhcpcd - * wpa_supplicant - TEXT EDITORS - * nano - * vim - * neatvi - * nvi - * emacs - * emacs-nox (terminal-only version of emacs) - USER SHELLS - * bash - * zsh - * dash - * oksh - * rc - POSIX BASE UTILITIES - * busybox - * sbase - * coreutils - DOCUMENTATION - * carbs-docs - * man-pages - * man-pages-posix - -1.2.5 Obtaining the documentation (optional) --------------------------------------------- - -All the documentation for Carbs Linux can be found on a single info -manual to be viewed offline. You can obtain texinfo or the info -(standalone) package in order to view the documentation. - - Install the documentation. - $ cpt b carbs-docs && cpt i carbs-docs - - Install either texinfo or the info package. We will be installing standalone info - as it doesn't need perl. - $ cpt b info && cpt i info - - You can then run info and navigate through the documentation. - $ info carbslinux - -1.3 System Configuration -======================== - -After you have finished installing some extra packages, you can -configure your system to your liking. - -1.3.1 Configuring hostname (recommended) ----------------------------------------- - -You might want to add a hostname, especially in a networked environment. -Your hostname will default to 'carbslinux' unless you set this. - - $ echo your-hostname > /etc/hostname - -1.3.2 Setting up hosts file (optional) --------------------------------------- - -You can edit your /etc/hosts file, which is the static lookup table for -host names. By default, there are two entries for localhost which are -OKAY. You can replace the 'localhost' part of these entries to your -hostname. - - 127.0.0.1 localhost.localdomain localhost - ::1 localhost.localdomain localhost ip6-localhost - -1.4 Kernel -========== - -Kernel isn't managed under the main repositories, even though you could -package one for your personal use. Here is an example kernel package -(<a href=https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux>https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux</a>), -which you will need to reconfigure for your specific setup if you want -to make use of it. - -1.4.1 Obtaining the kernel sources ----------------------------------- - -You can visit the <a href=https://kernel.org>https://kernel.org</a> website to choose a kernel that you -want to install. Though only the latest stable and longterm (LTS) -versions are supported. - - Download the kernel and extract it - $ wget <a href=https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz>https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz</a> - $ tar xf linux-5.7.6.tar.xz - - Change directory into the kernel sources - $ cd linux-5.7.6 - -1.4.2 Installing dependencies ------------------------------ - -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'. - - The package manager asks to install if you are building more than one package, - so no need to run 'cpt i ...' - $ cpt b libelf ncurses - - In the vanilla kernel sources, you need perl to compile the kernel, -but it can be easily patched out. You will need to apply the following -patch. Patch was written by E5ten (<a href=https://github.com/E5ten>https://github.com/E5ten</a>). You will -need to obtain and apply the patch in the kernel source directory. - - $ wget <a href=https://dl.carbslinux.org/distfiles/kernel-no-perl.patch>https://dl.carbslinux.org/distfiles/kernel-no-perl.patch</a> - $ patch -p1 < kernel-no-perl.patch - -1.4.3 Compiling the kernel --------------------------- - -Next step is configuring and building the kernel. You can check -Gentoo's kernel configuration guide -(<a href=https://wiki.gentoo.org/wiki/Kernel/Configuration>https://wiki.gentoo.org/wiki/Kernel/Configuration</a>) to learn more about -the matter. Overall, Gentoo Wiki is a good place to learn about -configuration according to your hardware. The following will assume a -monolithic kernel. - - $ make menuconfig - $ make - $ install -Dm755 $(make -s image_name) /boot/vmlinuz-linux - -1.5 Making your system bootable -=============================== - -In order to be able to boot your fresh system, wou will need an -init-daemon, init-scripts and a bootloader. The init daemon is already -provided by busybox, but you can optionally change it. - -1.5.1 Installing a bootloader ------------------------------ - -In the main repository, there is efibootmgr and grub to serve as -bootloaders. efibootmgr can be used as a standalone bootloader, or can -be used to install grub in a UEFI environment. efibootmgr is needed -unless you are using a device without UEFI support (or you really want -to use BIOS for a reason). - - GRUB BIOS installation - - $ cpt b grub && cpt i grub - $ grub-install --target=i386-pc /dev/sdX - $ grub-mkconfig -o /boot/grub/grub.cfg - - GRUB UEFI installation - - $ cpt b efibootmgr && cpt i efibootmgr - $ cpt b grub && cpt i grub - - $ grub-install --target=x86_64-efi \ - --efi-directory=esp \ - --bootloader-id=CarbsLinux - - $ grub-mkconfig -o /boot/grub/grub.cfg - -1.5.2 Installing init scripts ------------------------------ - -Only thing left to do is installing the init-scripts, and now you are -almost ready to boot your system! - - $ cpt b carbs-init && cpt i carbs-init - -1.5.3 Generating fstab ----------------------- - -You can now manually edit your fstab entry, or you can use the genfstab -tool. If you want to use the tool, exit the chroot and run the -following: - - $ wget <a href=https://github.com/cemkeylan/genfstab/raw/master/genfstab>https://github.com/cemkeylan/genfstab/raw/master/genfstab</a> - $ chmod +x genfstab - $ ./genfstab -U /mnt >> /mnt/etc/fstab - -1.6 Post-installation -===================== - -The base installation is now complete, you can now fine tune your system -according to your needs. Rest of these instructions are completely -optional. - -1.6.1 Acquiring kiss repositories ---------------------------------- - -While not 100% compatible with cpt, you can use kiss repositories in -your system the same way you are using the distribution repositories. -Here is an example for the KISS Linux Community repository. - - $ git clone <a href=https://github.com/kisslinux/community>https://github.com/kisslinux/community</a> $HOME/repos/kiss-community - $ export CPT_PATH=$CPT_PATH:$HOME/repos/kiss-community/community - - NOTE: There are lots of packages on the KISS community repository -that are also on Carbs Linux main repository. I would advise giving -lower priority to the KISS community repository as it may affect other -packages that you might install. - +</p> + +<p> +<b>BOOTLOADERS</b> +</p> + +<ul class="org-ul"> +<li>efibootmgr</li> +<li>grub</li> +</ul> + +<p> +<b>FILESYSTEMS</b> +</p> + +<ul class="org-ul"> +<li>e2fsprogs</li> +<li>dosfstools</li> +<li>ntfs-3g</li> +</ul> + +<p> +<b>NETWORKING</b> +</p> + +<ul class="org-ul"> +<li>dhcpcd</li> +<li>wpa<sub>supplicant</sub></li> +</ul> + +<p> +<b>TEXT EDITORS</b> +</p> + +<ul class="org-ul"> +<li>nano</li> +<li>vim</li> +<li>neatvi</li> +<li>emacs</li> +<li>emacs-nox (terminal-only version of emacs)</li> +</ul> + +<p> +<b>USER SHELLS</b> +</p> + +<ul class="org-ul"> +<li>bash</li> +<li>zsh</li> +<li>oksh</li> +<li>rc</li> +</ul> + +<p> +<b>POSIX BASE UTILITIES</b> +</p> + +<ul class="org-ul"> +<li>busybox</li> +<li>sbase</li> +<li>coreutils</li> +</ul> + +<p> +<b>DOCUMENTATION</b> +</p> + +<ul class="org-ul"> +<li>carbs-docs</li> +<li>man-pages</li> +<li>man-pages-posix</li> +</ul> +</div> +</div> + +<div id="outline-container-org1e0d5e0" class="outline-3"> +<h3 id="org1e0d5e0"><span class="section-number-3">2.5</span> Obtaining the documentation</h3> +<div class="outline-text-3" id="text-2-5"> +<p> +All the documentation for Carbs Linux can be found on a single info manual to be +viewed offline. You can obtain texinfo or the info (standalone) package in order +to view the documentation. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Install the documentation.</span> +cpt b carbs-docs && cpt i carbs-docs + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Install either texinfo or the info package. We will be installing standalone info</span> +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">as it doesn't need perl.</span> +cpt b info && cpt i info + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">You can then run info and navigate through the documentation.</span> +info carbslinux +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-orgd61a283" class="outline-2"> +<h2 id="orgd61a283"><span class="section-number-2">3</span> System Configuration</h2> +<div class="outline-text-2" id="text-3"> +<p> +After you have finished installing some extra packages, you can configure your +system to your liking. +</p> +</div> + +<div id="outline-container-orgc097724" class="outline-3"> +<h3 id="orgc097724"><span class="section-number-3">3.1</span> Configuring hostname</h3> +<div class="outline-text-3" id="text-3-1"> +<p> +You might want to add a hostname, especially in a networked environment. Your +hostname will default to 'carbslinux' unless you set this. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #16a085;">echo</span> your-hostname > /etc/hostname </pre> - <a href="/docs/install.txt">View Page Source</a> - <div class="border"></div> - <p class=footer>Linux® is a registered trademark of Linus Torvalds</p> - <p class=footer>Copyright © 2019-2020 Cem Keylan</p> - </body> +</div> +</div> +</div> + +<div id="outline-container-org88a7ef3" class="outline-3"> +<h3 id="org88a7ef3"><span class="section-number-3">3.2</span> Hosts file</h3> +<div class="outline-text-3" id="text-3-2"> +<p> +You can edit your /etc/hosts file, which is the static lookup table for host +names. By default, there are two entries for localhost which are OKAY. You can +replace the 'localhost' part of these entries to your hostname. +</p> + +<pre class="example"> +127.0.0.1 localhost.localdomain localhost +::1 localhost.localdomain localhost ip6-localhost +</pre> +</div> +</div> +</div> + +<div id="outline-container-org92806b4" class="outline-2"> +<h2 id="org92806b4"><span class="section-number-2">4</span> Kernel</h2> +<div class="outline-text-2" id="text-4"> +<p> +Kernel isn't managed under the main repositories, even though you could package +one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, which you will +need to reconfigure for your specific setup if you want to make use of it. +</p> +</div> + +<div id="outline-container-orgb246a4d" class="outline-3"> +<h3 id="orgb246a4d"><span class="section-number-3">4.1</span> Obtaining the kernel sources</h3> +<div class="outline-text-3" id="text-4-1"> +<p> +You can visit the <a href="https://kernel.org">https://kernel.org</a> website to choose a kernel that you want +to install. Though only the latest stable and longterm (LTS) versions are +supported. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Download the kernel and extract it</span> +wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz +tar xf linux-5.9.1.tar.xz + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Change directory into the kernel sources</span> +<span style="color: #16a085;">cd</span> linux-5.9.1 +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf9a076f" class="outline-3"> +<h3 id="orgf9a076f"><span class="section-number-3">4.2</span> Kernel dependencies</h3> +<div class="outline-text-3" id="text-4-2"> +<p> +In order to compile the kernel you will need to install some dependencies. You +will need <code>libelf</code> to compile the kernel. If you want to configure using the +menu interface you will also need <code>ncurses</code>. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">The package manager asks to install if you are building more than one package,</span> +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">so no need to run 'cpt i ...'</span> +cpt b libelf ncurses +</pre> +</div> + +<p> +In the vanilla kernel sources, you need perl to compile the kernel, but it can +be easily patched out. You will need to apply the following patch. Patch was +written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and apply the patch in the kernel +source directory. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch +patch -p1 < kernel-no-perl.patch +</pre> +</div> +</div> +</div> + +<div id="outline-container-orga3c74bc" class="outline-3"> +<h3 id="orga3c74bc"><span class="section-number-3">4.3</span> Building the kernel</h3> +<div class="outline-text-3" id="text-4-3"> +<p> +Next step is configuring and building the kernel. You can check Gentoo's +<a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> to learn more about the matter. Overall, Gentoo Wiki +is a good place to learn about configuration according to your hardware. The +following will assume a monolithic kernel. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">make menuconfig +make +install -Dm755 $(make -s image_name) /boot/vmlinuz-linux +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-orgb176eb1" class="outline-2"> +<h2 id="orgb176eb1"><span class="section-number-2">5</span> Making your system bootable</h2> +<div class="outline-text-2" id="text-5"> +<p> +In order to be able to boot your fresh system, wou will need an init-daemon, +init-scripts and a bootloader. The init daemon is already provided by busybox, +but you can optionally change it. +</p> +</div> + +<div id="outline-container-org31a5fde" class="outline-3"> +<h3 id="org31a5fde"><span class="section-number-3">5.1</span> Bootloader</h3> +<div class="outline-text-3" id="text-5-1"> +<p> +In the main repository, there is efibootmgr and grub to serve as bootloaders. +efibootmgr can be used as a standalone bootloader, or can be used to install +grub in a UEFI environment. efibootmgr is needed unless you are using a device +without UEFI support (or you really want to use BIOS for a reason). +</p> +</div> + +<div id="outline-container-org43ed898" class="outline-4"> +<h4 id="org43ed898"><span class="section-number-4">5.1.1</span> GRUB BIOS installation</h4> +<div class="outline-text-4" id="text-5-1-1"> +<div class="org-src-container"> +<pre class="src src-sh">cpt b grub && cpt i grub +grub-install --target=i386-pc /dev/sdX +grub-mkconfig -o /boot/grub/grub.cfg +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf826efe" class="outline-4"> +<h4 id="orgf826efe"><span class="section-number-4">5.1.2</span> GRUB UEFI installation</h4> +<div class="outline-text-4" id="text-5-1-2"> +<div class="org-src-container"> +<pre class="src src-sh">cpt b efibootmgr && cpt i efibootmgr +cpt b grub && cpt i grub + +grub-install --target=x86_64-efi <span style="color: #0a74b9;">\</span> + --efi-directory=esp <span style="color: #0a74b9;">\</span> + --bootloader-id=CarbsLinux + +grub-mkconfig -o /boot/grub/grub.cfg +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org2d43b5f" class="outline-3"> +<h3 id="org2d43b5f"><span class="section-number-3">5.2</span> Init scripts</h3> +<div class="outline-text-3" id="text-5-2"> +<p> +Only thing left to do is installing the init-scripts, and now you are almost +ready to boot your system! +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt b carbs-init && cpt i carbs-init +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgfe8161b" class="outline-3"> +<h3 id="orgfe8161b"><span class="section-number-3">5.3</span> Fstab</h3> +<div class="outline-text-3" id="text-5-3"> +<p> +You can now manually edit your fstab entry, or you can use the genfstab tool. +If you want to use the tool, exit the chroot and run the following: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://github.com/cemkeylan/genfstab/raw/master/genfstab +chmod +x genfstab +./genfstab -U /mnt >> /mnt/etc/fstab +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org917e2c8" class="outline-2"> +<h2 id="org917e2c8"><span class="section-number-2">6</span> Post-installation</h2> +<div class="outline-text-2" id="text-6"> +<p> +The base installation is now complete, you can now fine tune your system +according to your needs. Rest of these instructions are completely optional. +You can check the rest of the documentation to learn more about the system. +</p> +</div> + +<div id="outline-container-org96641ac" class="outline-3"> +<h3 id="org96641ac"><span class="section-number-3">6.1</span> KISS repositories</h3> +<div class="outline-text-3" id="text-6-1"> +<p> +While not 100% compatible with cpt, you can use kiss repositories in your +system the same way you are using the distribution repositories. Here is an +example for the KISS Linux Community repository. +</p> +</div> +</div> +</div> +</div> +</body> </html> diff --git a/docs/docs/install.txt b/docs/docs/install.txt index 50ad008..f7a6881 100644 --- a/docs/docs/install.txt +++ b/docs/docs/install.txt @@ -1,364 +1,481 @@ -1 Installation -************** + ________________________________ -These are the step-by-step instructions for installing Carbs Linux. + CARBS LINUX INSTALLATION GUIDE -1.1 Preparing Environment -========================= + Cem Keylan + ________________________________ -To install Carbs Linux, you will need a Live Linux ISO. For that -purpose, you can obtain a Gentoo or Void Linux live image. You can -follow their instructions to boot and setup your network. - You will need the following programs in order to install Carbs Linux: +Table of Contents +_________________ - * tar - * wget - * xz - * some form of base utilities (coreutils, sbase, busybox, etc.) +1. Preparing Environment +.. 1. Download +.. 2. Signature verification +.. 3. Extracting the tarball +.. 4. Obtain the chroot helper +2. Chroot +.. 1. Setting up repositories +..... 1. Obtaining from git +..... 2. Obtaining from rsync +..... 3. Making the package manager use the 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 +..... 1. GRUB BIOS installation +..... 2. GRUB UEFI installation +.. 2. Init scripts +.. 3. Fstab +6. Post-installation +.. 1. KISS repositories - Rest of these instructions will assume that you have set all of these -up, and will continue on that point. -1.1.1 Download --------------- +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>. -First, we need to download the rootfs tarball. You can do the following -in order to obtain the rootfs. If you are using an i686 machine, -replace the 'x86_64' with 'i686'. We are setting this in a URL variable -so that we don't have to write it every time. - $ URL=https://dl.carbslinux.org/releases/x86_64 - $ wget $URL/carbs-rootfs.tar.xz +1 Preparing Environment +======================= - We can then check the integrity of the tarball and do a signature -verification. Even thought these are optional, they are highly -recommended. + To install Carbs Linux, you will need a Live Linux ISO. For that + purpose, you can obtain a Gentoo or Void Linux live image. You can + follow their instructions to boot and setup your network. -1.1.2 Check the integrity of the tarball (Recommended) ------------------------------------------------------- + You will need the following programs in order to install Carbs Linux: -All of the releases are saved in a single file named 'sha256sums.txt', -but the latest release is saved on 'carbs-rootfs.tar.xz.sha256'. You -can acquire and verify the tarball. + - tar + - wget + - xz + - some form of base utilities (coreutils, sbase, busybox, etc.) - $ wget $URL/carbs-rootfs.tar.xz.sha256 - $ sha256sum -c carbs-rootfs.tar.xz.sha256 + Rest of these instructions will assume that you have set all of these + up, and will continue on that point. -1.1.3 Verify the signature + +1.1 Download +~~~~~~~~~~~~ + + First, we need to download the rootfs tarball. You can do the + following in order to obtain the rootfs. If you are using an i686 + machine, replace the `x86_64' with `i686'. We are setting this in a + URL variable so that we don't have to write it every time. + + ,---- + | wget $URL/carbs-rootfs.tar.xz.sha256 + | sha256sum -c carbs-rootfs.tar.xz.sha256 + `---- + + +1.2 Signature verification +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + It is highly recommended to verify the signature of the tarball. You + will need GPG for this. + + ,---- + | wget $URL/carbs-rootfs.tar.xz.sig + | gpg --recv-keys FF484BDFEFCEF8FF + | gpg --verify carbs-rootfs.tar.xz.sig + `---- + + +1.3 Extracting the tarball +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You will need to extract the tarball to your desired location. For + partitioning, you can follow [this guide]. This will assume that you + will be mounting your root partition to `/mnt'. + + ,---- + | mount /dev/sdx1 /mnt + | tar xf carbs-rootfs.tar.xz -C /mnt + `---- + + +[this guide] <https://wiki.archlinux.org/index.php/Partitioning> + + +1.4 Obtain the chroot helper +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You can obtain the `cpt-chroot' script in order to do a simple chroot + into your new root filesystem. + + ,---- + | wget https://dl.carbslinux.org/distfiles/cpt-chroot + | chmod a+x cpt-chroot + `---- + + +2 Chroot +======== + + Chroot into Carbs Linux! + + ,---- + | ./cpt-chroot /mnt + `---- + + +2.1 Setting up repositories +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Newest tarballs do not come with repositories, so you will need to + manually obtain them, and set your `CPT_PATH' environment + variable. Carbs Linux repositories can either be obtained by `git' or + `rsync'. While rsync repositories are overall faster and smaller, git + offers the whole history of the repository and a means to manipulate + your repository as you like it. If you want to obtain the git + repository, you will need to install `git' itself. + + The following guide will assume that you put the repositories into + `~/repos/' directory, but you can put the repositories into any + directory you want. So go ahead and create that directory: + + ,---- + | mkdir -p $HOME/repos + `---- + + +2.1.1 Obtaining from git +------------------------ + + Carbs Linux git repositories can be found both from the main server + and GitHub (mirror). Here are both their repository links. You can + clone any of them. + + - git://git.carbslinux.org/repository + - <https://github.com/carbslinux/repository> + + ,---- + | git clone git://git.carbslinux.org/repository $HOME/repos/carbs + `---- + + +2.1.2 Obtaining from rsync -------------------------- -It is highly recommended to verify the signature of the tarball. You -will need GPG for this. + Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In + order to obtain it, run the following: - $ wget $URL/carbs-rootfs.tar.xz.sig - $ gpg --recv-keys FF484BDFEFCEF8FF - $ gpg --verify carbs-rootfs.tar.xz.sig + ,---- + | rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs + `---- -1.1.4 Extracting the tarball ----------------------------- -You will need to extract the tarball to your desired location. For -partitioning, you can follow this guide -(https://wiki.archlinux.org/index.php/Partitioning). This will assume -that you will be mounting your root partition to '/mnt'. +2.1.3 Making the package manager use the repositories +----------------------------------------------------- - $ mount /dev/sdx1 /mnt - $ tar xf carbs-rootfs.tar.xz -C /mnt + In your shell's configuration file, or in your `~/.profile' file, add + the following lines: -1.1.5 Obtain the chroot helper ------------------------------- + ,---- + | CPT_PATH=$HOME/repos/carbs/core + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community + | export CPT_PATH + `---- -You can obtain the 'cpt-chroot' script in order to do a simple chroot -into your new root filesystem. - $ wget https://dl.carbslinux.org/distfiles/cpt-chroot - $ chmod a+x cpt-chroot +2.2 Updating packages +~~~~~~~~~~~~~~~~~~~~~ -1.2 Chroot -========== + It is good practice to make sure your system is up to date, especially + before building new packages. If there is an update for the package + manager you will need to update twice. -Chroot into Carbs Linux! + ,---- + | cpt-update && cpt-update + `---- - $ ./cpt-chroot /mnt -1.2.1 Setting up repositories ------------------------------ +2.3 Installing packages +~~~~~~~~~~~~~~~~~~~~~~~ -Newest tarballs do not come with repositories, so you will need to -manually obtain them, and set your 'CPT_PATH' environment variable. -Carbs Linux repositories can either be obtained by 'git' or 'rsync'. -While rsync repositories are overall faster and smaller, git offers the -whole history of the repository and a means to manipulate your -repository as you like it. If you want to obtain the git repository, -you will need to install 'git' itself. + Since you are operating on a really small base, you might need to + build and install new programs to extend the functionality of your + system. In order to build and install packages new packages in Carbs, + you need to execute the following. "Package" is not actually a package + and is given as an example. - The following guide will assume that you put the repositories into -'~/repos/' directory, but you can put the repositories into any -directory you want. So go ahead and create that directory: + ,---- + | cpt-build package + | cpt-install package + `---- - $ mkdir -p $HOME/repos -1.2.1.1 Obtaining from rsync -............................ +2.4 Essential Software +~~~~~~~~~~~~~~~~~~~~~~ -Carbs Linux rsync repositories live in <rsync://carbslinux.org/repo>. -In order to obtain it, run the following: + Here is a list of software that you might want to have on your system. - $ rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs + *BOOTLOADERS* -1.2.1.2 Obtaining from git -.......................... + - efibootmgr + - grub -Carbs Linux git repositories can be found both from the main server and -GitHub (mirror). Here are both their repository links. You can clone -any of them. + *FILESYSTEMS* - * <git://git.carbslinux.org/repository> - * <https://github.com/carbslinux/repository> + - e2fsprogs + - dosfstools + - ntfs-3g - $ git clone git://git.carbslinux.org/repository $HOME/repos/carbs + *NETWORKING* -1.2.1.3 Making the package manager use the repositories -....................................................... + - dhcpcd + - wpa_supplicant -In your shell's configuration file, or in your '~/.profile' file, add -the following lines: + *TEXT EDITORS* - export CPT_PATH='' - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/core - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community - export CPT_PATH + - nano + - vim + - neatvi + - emacs + - emacs-nox (terminal-only version of emacs) -1.2.2 Updating packages ------------------------ + *USER SHELLS* -It is good practice to make sure your system is up to date, especially -before building new packages. If there is an update for the package -manager you will need to update twice. + - bash + - zsh + - oksh + - rc - $ cpt update + *POSIX BASE UTILITIES* -1.2.3 Installing packages -------------------------- + - busybox + - sbase + - coreutils -Since you are operating on a really small base, you might need to build -and install new programs to extend the functionality of your system. In -order to build and install packages new packages in Carbs, you need to -execute the following. "Package" is not actually a package and is given -as an example. + *DOCUMENTATION* - $ cpt build package - $ cpt install package + - carbs-docs + - man-pages + - man-pages-posix -1.2.4 Essential Software ------------------------- -Here is a list of software that you might want to have on your system. - - BOOTLOADERS - * efibootmgr - * grub - FILESYSTEMS - * e2fsprogs - * dosfstools - * ntfs-3g - NETWORKING - * dhcpcd - * wpa_supplicant - TEXT EDITORS - * nano - * vim - * neatvi - * nvi - * emacs - * emacs-nox (terminal-only version of emacs) - USER SHELLS - * bash - * zsh - * dash - * oksh - * rc - POSIX BASE UTILITIES - * busybox - * sbase - * coreutils - DOCUMENTATION - * carbs-docs - * man-pages - * man-pages-posix - -1.2.5 Obtaining the documentation (optional) --------------------------------------------- - -All the documentation for Carbs Linux can be found on a single info -manual to be viewed offline. You can obtain texinfo or the info -(standalone) package in order to view the documentation. - - Install the documentation. - $ cpt b carbs-docs && cpt i carbs-docs - - Install either texinfo or the info package. We will be installing standalone info - as it doesn't need perl. - $ cpt b info && cpt i info - - You can then run info and navigate through the documentation. - $ info carbslinux - -1.3 System Configuration -======================== - -After you have finished installing some extra packages, you can -configure your system to your liking. - -1.3.1 Configuring hostname (recommended) ----------------------------------------- - -You might want to add a hostname, especially in a networked environment. -Your hostname will default to 'carbslinux' unless you set this. - - $ echo your-hostname > /etc/hostname - -1.3.2 Setting up hosts file (optional) --------------------------------------- - -You can edit your /etc/hosts file, which is the static lookup table for -host names. By default, there are two entries for localhost which are -OKAY. You can replace the 'localhost' part of these entries to your -hostname. - - 127.0.0.1 localhost.localdomain localhost - ::1 localhost.localdomain localhost ip6-localhost - -1.4 Kernel -========== - -Kernel isn't managed under the main repositories, even though you could -package one for your personal use. Here is an example kernel package -(https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux), -which you will need to reconfigure for your specific setup if you want -to make use of it. - -1.4.1 Obtaining the kernel sources ----------------------------------- - -You can visit the https://kernel.org website to choose a kernel that you -want to install. Though only the latest stable and longterm (LTS) -versions are supported. - - Download the kernel and extract it - $ wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz - $ tar xf linux-5.7.6.tar.xz - - Change directory into the kernel sources - $ cd linux-5.7.6 - -1.4.2 Installing dependencies ------------------------------ - -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'. - - The package manager asks to install if you are building more than one package, - so no need to run 'cpt i ...' - $ cpt b libelf ncurses - - In the vanilla kernel sources, you need perl to compile the kernel, -but it can be easily patched out. You will need to apply the following -patch. Patch was written by E5ten (https://github.com/E5ten). You will -need to obtain and apply the patch in the kernel source directory. - - $ wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch - $ patch -p1 < kernel-no-perl.patch +2.5 Obtaining the documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1.4.3 Compiling the kernel --------------------------- + All the documentation for Carbs Linux can be found on a single info + manual to be viewed offline. You can obtain texinfo or the info + (standalone) package in order to view the documentation. -Next step is configuring and building the kernel. You can check -Gentoo's kernel configuration guide -(https://wiki.gentoo.org/wiki/Kernel/Configuration) to learn more about -the matter. Overall, Gentoo Wiki is a good place to learn about -configuration according to your hardware. The following will assume a -monolithic kernel. + ,---- + | # Install the documentation. + | cpt b carbs-docs && cpt i carbs-docs + | + | # Install either texinfo or the info package. We will be installing standalone info + | # as it doesn't need perl. + | cpt b info && cpt i info + | + | # You can then run info and navigate through the documentation. + | info carbslinux + `---- - $ make menuconfig - $ make - $ install -Dm755 $(make -s image_name) /boot/vmlinuz-linux -1.5 Making your system bootable -=============================== +3 System Configuration +====================== -In order to be able to boot your fresh system, wou will need an -init-daemon, init-scripts and a bootloader. The init daemon is already -provided by busybox, but you can optionally change it. + After you have finished installing some extra packages, you can + configure your system to your liking. -1.5.1 Installing a bootloader ------------------------------ -In the main repository, there is efibootmgr and grub to serve as -bootloaders. efibootmgr can be used as a standalone bootloader, or can -be used to install grub in a UEFI environment. efibootmgr is needed -unless you are using a device without UEFI support (or you really want -to use BIOS for a reason). +3.1 Configuring hostname +~~~~~~~~~~~~~~~~~~~~~~~~ - GRUB BIOS installation + You might want to add a hostname, especially in a networked + environment. Your hostname will default to 'carbslinux' unless you set + this. - $ cpt b grub && cpt i grub - $ grub-install --target=i386-pc /dev/sdX - $ grub-mkconfig -o /boot/grub/grub.cfg + ,---- + | echo your-hostname > /etc/hostname + `---- - GRUB UEFI installation - $ cpt b efibootmgr && cpt i efibootmgr - $ cpt b grub && cpt i grub +3.2 Hosts file +~~~~~~~~~~~~~~ + + You can edit your /etc/hosts file, which is the static lookup table + for host names. By default, there are two entries for localhost which + are OKAY. You can replace the 'localhost' part of these entries to + your hostname. + + ,---- + | 127.0.0.1 localhost.localdomain localhost + | ::1 localhost.localdomain localhost ip6-localhost + `---- + + +4 Kernel +======== + + Kernel isn't managed under the main repositories, even though you + could package one for your personal use. Here is an [example kernel + package], which you will need to reconfigure for your specific setup + if you want to make use of it. + + +[example kernel package] +<https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux> + +4.1 Obtaining the kernel sources +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You can visit the <https://kernel.org> website to choose a kernel that + you want to install. Though only the latest stable and longterm (LTS) + versions are supported. + + ,---- + | # Download the kernel and extract it + | wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz + | tar xf linux-5.9.1.tar.xz + | + | # Change directory into the kernel sources + | cd linux-5.9.1 + `---- + + +4.2 Kernel dependencies +~~~~~~~~~~~~~~~~~~~~~~~ + + 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'. + + ,---- + | # The package manager asks to install if you are building more than one package, + | # so no need to run 'cpt i ...' + | cpt b libelf ncurses + `---- + + In the vanilla kernel sources, you need perl to compile the kernel, + but it can be easily patched out. You will need to apply the following + patch. Patch was written by [E5ten]. You will need to obtain and apply + the patch in the kernel source directory. + + ,---- + | wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch + | patch -p1 < kernel-no-perl.patch + `---- + + +[E5ten] <https://github.com/E5ten> + + +4.3 Building the kernel +~~~~~~~~~~~~~~~~~~~~~~~ + + Next step is configuring and building the kernel. You can check + Gentoo's [kernel configuration guide] to learn more about the + matter. Overall, Gentoo Wiki is a good place to learn about + configuration according to your hardware. The following will assume a + monolithic kernel. + + ,---- + | make menuconfig + | make + | install -Dm755 $(make -s image_name) /boot/vmlinuz-linux + `---- + + +[kernel configuration guide] +<https://wiki.gentoo.org/wiki/Kernel/Configuration> + + +5 Making your system bootable +============================= + + In order to be able to boot your fresh system, wou will need an + init-daemon, init-scripts and a bootloader. The init daemon is already + provided by busybox, but you can optionally change it. + + +5.1 Bootloader +~~~~~~~~~~~~~~ + + In the main repository, there is efibootmgr and grub to serve as + bootloaders. efibootmgr can be used as a standalone bootloader, or + can be used to install grub in a UEFI environment. efibootmgr is + needed unless you are using a device without UEFI support (or you + really want to use BIOS for a reason). + + +5.1.1 GRUB BIOS installation +---------------------------- + + ,---- + | cpt b grub && cpt i grub + | grub-install --target=i386-pc /dev/sdX + | grub-mkconfig -o /boot/grub/grub.cfg + `---- + + +5.1.2 GRUB UEFI installation +---------------------------- - $ grub-install --target=x86_64-efi \ - --efi-directory=esp \ - --bootloader-id=CarbsLinux + ,---- + | cpt b efibootmgr && cpt i efibootmgr + | cpt b grub && cpt i grub + | + | grub-install --target=x86_64-efi \ + | --efi-directory=esp \ + | --bootloader-id=CarbsLinux + | + | grub-mkconfig -o /boot/grub/grub.cfg + `---- - $ grub-mkconfig -o /boot/grub/grub.cfg -1.5.2 Installing init scripts ------------------------------ +5.2 Init scripts +~~~~~~~~~~~~~~~~ -Only thing left to do is installing the init-scripts, and now you are -almost ready to boot your system! + Only thing left to do is installing the init-scripts, and now you are + almost ready to boot your system! - $ cpt b carbs-init && cpt i carbs-init + ,---- + | cpt b carbs-init && cpt i carbs-init + `---- -1.5.3 Generating fstab ----------------------- -You can now manually edit your fstab entry, or you can use the genfstab -tool. If you want to use the tool, exit the chroot and run the -following: +5.3 Fstab +~~~~~~~~~ - $ wget https://github.com/cemkeylan/genfstab/raw/master/genfstab - $ chmod +x genfstab - $ ./genfstab -U /mnt >> /mnt/etc/fstab + You can now manually edit your fstab entry, or you can use the + genfstab tool. If you want to use the tool, exit the chroot and run + the following: -1.6 Post-installation -===================== + ,---- + | wget https://github.com/cemkeylan/genfstab/raw/master/genfstab + | chmod +x genfstab + | ./genfstab -U /mnt >> /mnt/etc/fstab + `---- -The base installation is now complete, you can now fine tune your system -according to your needs. Rest of these instructions are completely -optional. -1.6.1 Acquiring kiss repositories ---------------------------------- +6 Post-installation +=================== -While not 100% compatible with cpt, you can use kiss repositories in -your system the same way you are using the distribution repositories. -Here is an example for the KISS Linux Community repository. + The base installation is now complete, you can now fine tune your + system according to your needs. Rest of these instructions are + completely optional. You can check the rest of the documentation to + learn more about the system. - $ git clone https://github.com/kisslinux/community $HOME/repos/kiss-community - $ export CPT_PATH=$CPT_PATH:$HOME/repos/kiss-community/community - NOTE: There are lots of packages on the KISS community repository -that are also on Carbs Linux main repository. I would advise giving -lower priority to the KISS community repository as it may affect other -packages that you might install. +6.1 KISS repositories +~~~~~~~~~~~~~~~~~~~~~ + While not 100% compatible with cpt, you can use kiss repositories in + your system the same way you are using the distribution + repositories. Here is an example for the KISS Linux Community + repository. diff --git a/docs/index.html b/docs/index.html index 95a0b97..b25bd06 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/mailing-lists.html b/docs/mailing-lists.html index d738429..6435eb5 100644 --- a/docs/mailing-lists.html +++ b/docs/mailing-lists.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/news.html b/docs/news.html index 539643f..cc8f630 100644 --- a/docs/news.html +++ b/docs/news.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/news.xml b/docs/news.xml index 192e4ca..5a1c054 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -9,7 +9,7 @@ <description>a simple linux distribution</description> <link>https://carbslinux.org</link> <atom:link href="https://carbslinux.org/news.xml" rel="self" type="application/rss+xml" /> - <lastBuildDate>Thu Dec 10 2020 12:00</lastBuildDate> + <lastBuildDate>Sat Dec 26 2020 00:00</lastBuildDate> <item> <title>Sep 16 2020</title> <pubDate>Wed, 16 Sep 2020</pubDate> diff --git a/docs/people.html b/docs/people.html index 5b35c1f..64837d9 100644 --- a/docs/people.html +++ b/docs/people.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/docs/rss.xml b/docs/rss.xml index 6982168..dc8add0 100644 --- a/docs/rss.xml +++ b/docs/rss.xml @@ -9,7 +9,7 @@ <description>a simple linux distribution</description> <link>https://carbslinux.org</link> <atom:link href="https://carbslinux.org/rss.xml" rel="self" type="application/rss+xml" /> - <lastBuildDate>Thu Dec 10 2020 12:00</lastBuildDate> + <lastBuildDate>Sat Dec 26 2020 00:00</lastBuildDate> <item> <title>First Year of Carbs Linux</title> <pubDate>Thu, 10 Dec 2020</pubDate> diff --git a/src/docs/0010.html b/src/docs/0010.html index 495a177..fad5ef3 100644 --- a/src/docs/0010.html +++ b/src/docs/0010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0010"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0010"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0010">0010</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0010">0010</a>.</p> </body> diff --git a/src/docs/0011.html b/src/docs/0011.html index f1cc6bb..ab45257 100644 --- a/src/docs/0011.html +++ b/src/docs/0011.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0011"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0011"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0011">0011</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0011">0011</a>.</p> </body> diff --git a/src/docs/0012.html b/src/docs/0012.html index a53264a..32dca75 100644 --- a/src/docs/0012.html +++ b/src/docs/0012.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0012"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0012"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0012">0012</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0012">0012</a>.</p> </body> diff --git a/src/docs/0013.html b/src/docs/0013.html index 95fee3c..27102b1 100644 --- a/src/docs/0013.html +++ b/src/docs/0013.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=General-Conventions.html#g_t0013"> +<meta http-equiv="Refresh" content="0; url=Conventions.html#g_t0013"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="General-Conventions.html#g_t0013">0013</a>.</p> +<p>The node you are looking for is at <a href="Conventions.html#g_t0013">0013</a>.</p> </body> diff --git a/src/docs/1010.html b/src/docs/1010.html index a202655..a9635e8 100644 --- a/src/docs/1010.html +++ b/src/docs/1010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1020.html b/src/docs/1020.html index a5625c3..2f73bac 100644 --- a/src/docs/1020.html +++ b/src/docs/1020.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1030.html b/src/docs/1030.html index a115463..bb51640 100644 --- a/src/docs/1030.html +++ b/src/docs/1030.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1040.html b/src/docs/1040.html index 23b0de0..ae10d79 100644 --- a/src/docs/1040.html +++ b/src/docs/1040.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1041.html b/src/docs/1041.html index 5e893c8..a75e629 100644 --- a/src/docs/1041.html +++ b/src/docs/1041.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1042.html b/src/docs/1042.html index b2512eb..c9e5426 100644 --- a/src/docs/1042.html +++ b/src/docs/1042.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1043.html b/src/docs/1043.html index 81f9202..32807ad 100644 --- a/src/docs/1043.html +++ b/src/docs/1043.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/1050.html b/src/docs/1050.html index 514d9bf..c913527 100644 --- a/src/docs/1050.html +++ b/src/docs/1050.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2010.html b/src/docs/2010.html index af89e0b..482ddf3 100644 --- a/src/docs/2010.html +++ b/src/docs/2010.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2020.html b/src/docs/2020.html index 62725ba..dab5be2 100644 --- a/src/docs/2020.html +++ b/src/docs/2020.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2030.html b/src/docs/2030.html index d9da18e..353fd6f 100644 --- a/src/docs/2030.html +++ b/src/docs/2030.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2040.html b/src/docs/2040.html index 166fefe..84e108a 100644 --- a/src/docs/2040.html +++ b/src/docs/2040.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2050.html b/src/docs/2050.html index 51dc0b5..a8b2a70 100644 --- a/src/docs/2050.html +++ b/src/docs/2050.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2210.html b/src/docs/2210.html index bf28d26..1304a27 100644 --- a/src/docs/2210.html +++ b/src/docs/2210.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2211.html b/src/docs/2211.html index dc1e677..9d2f2b3 100644 --- a/src/docs/2211.html +++ b/src/docs/2211.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2212.html b/src/docs/2212.html index f34310a..e14d231 100644 --- a/src/docs/2212.html +++ b/src/docs/2212.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2220.html b/src/docs/2220.html index 3cabc62..4012c71 100644 --- a/src/docs/2220.html +++ b/src/docs/2220.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2230.html b/src/docs/2230.html index c5fbbdd..b03a69c 100644 --- a/src/docs/2230.html +++ b/src/docs/2230.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2240.html b/src/docs/2240.html index 5a2f9e0..c8e98f2 100644 --- a/src/docs/2240.html +++ b/src/docs/2240.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/src/docs/2241.html b/src/docs/2241.html index 80cdd37..dba5354 100644 --- a/src/docs/2241.html +++ b/src/docs/2241.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> diff --git a/docs/docs/cptforce.html b/src/docs/ADDENDUM-How-to-use-this-License-for-your-documents.html index 531869a..b3423c8 100644 --- a/docs/docs/cptforce.html +++ b/src/docs/ADDENDUM-How-to-use-this-License-for-your-documents.html @@ -7,15 +7,16 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <!-- This file redirects to the location of a node or anchor --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cptforce (Carbs Linux User Manual)</title> +<title>ADDENDUM How to use this License for your documents (Carbs Linux User Manual)</title> -<meta name="description" content="cptforce (Carbs Linux User Manual)"> -<meta name="keywords" content="cptforce (Carbs Linux User Manual)"> +<meta name="description" content="ADDENDUM How to use this License for your documents (Carbs Linux User Manual)"> +<meta name="keywords" content="ADDENDUM How to use this License for your documents (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> @@ -38,11 +39,11 @@ ul.no-bullet {list-style: none} --> </style> -<meta http-equiv="Refresh" content="0; url=Environment-Variables.html#cptforce"> +<meta http-equiv="Refresh" content="0; url=GNU-Free-Documentation-License.html#ADDENDUM-How-to-use-this-License-for-your-documents"> </head> <body lang="en"> -<p>The node you are looking for is at <a href="Environment-Variables.html#cptforce">cptforce</a>.</p> +<p>The node you are looking for is at <a href="GNU-Free-Documentation-License.html#ADDENDUM-How-to-use-this-License-for-your-documents">ADDENDUM How to use this License for your documents</a>.</p> </body> diff --git a/docs/docs/cpt_002dalternatives.html b/src/docs/Bootloader.html index df24945..6f23a5b 100644 --- a/docs/docs/cpt_002dalternatives.html +++ b/src/docs/Bootloader.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-alternatives (Carbs Linux User Manual)</title> +<title>Bootloader (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-alternatives (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-alternatives (Carbs Linux User Manual)"> +<meta name="description" content="Bootloader (Carbs Linux User Manual)"> +<meta name="keywords" content="Bootloader (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dbuild.html" rel="next" title="cpt-build"> -<link href="Usage.html" rel="prev" title="Usage"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Init-scripts.html" rel="next" title="Init scripts"> +<link href="Making-your-system-bootable.html" rel="prev" title="Making your system bootable"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,44 +47,42 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dalternatives"></span><div class="header"> +<span id="Bootloader"></span><div class="header"> <p> -Next: <a href="cpt_002dbuild.html" accesskey="n" rel="next"><code>cpt-build</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Init-scripts.html" accesskey="n" rel="next">Init scripts</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dalternatives-1"></span><h4 class="subsection">2.1.1 <code>cpt-alternatives</code></h4> +<span id="Bootloader-1"></span><h4 class="subsection">1.5.1 Bootloader</h4> -<p>You can list and swap to alternatives using <code>cpt-alternatives</code>, or -<code>cpt a</code> for short. When run without alternatives, it will list -alternatives. It can read from standard input if <samp>-</samp> is given as an -argument. +<p>In the main repository, there is efibootmgr and grub to serve as bootloaders. +efibootmgr can be used as a standalone bootloader, or can be used to install +grub in a UEFI environment. efibootmgr is needed unless you are using a device +without UEFI support (or you really want to use BIOS for a reason). </p> +<ol> +<li> GRUB BIOS installation -<span id="Examples"></span><h4 class="unnumberedsubsubsec">Examples</h4> - -<p>List alternatives -</p> <div class="example"> -<pre class="example">$ cpt-alternatives -ncurses /usr/bin/clear -ncurses /usr/bin/reset +<pre class="example">cpt b grub && cpt i grub +grub-install --target=i386-pc /dev/sdX +grub-mkconfig -o /boot/grub/grub.cfg </pre></div> -<p>Swap to <code>clear</code> from <code>ncurses</code>. -</p> -<div class="example"> -<pre class="example">$ cpt-alternatives ncurses /usr/bin/clear --> Swapping '/usr/bin/clear' from 'busybox' to 'ncurses' -</pre></div> +</li><li> GRUB UEFI installation + -<p>Swap in bulk (all of sbase). -</p> <div class="example"> -<pre class="example">$ cpt a | grep ^sbase | cpt a - -</pre></div> +<pre class="example">cpt b efibootmgr && cpt i efibootmgr +cpt b grub && cpt i grub +grub-install --target=x86_64-efi \ + --efi-directory=esp \ + --bootloader-id=CarbsLinux +grub-mkconfig -o /boot/grub/grub.cfg +</pre></div> +</li></ol> diff --git a/src/docs/Building-the-kernel.html b/src/docs/Building-the-kernel.html new file mode 100644 index 0000000..e0f5ee2 --- /dev/null +++ b/src/docs/Building-the-kernel.html @@ -0,0 +1,72 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Building the kernel (Carbs Linux User Manual)</title> + +<meta name="description" content="Building the kernel (Carbs Linux User Manual)"> +<meta name="keywords" content="Building the kernel (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Making-your-system-bootable.html" rel="next" title="Making your system bootable"> +<link href="Kernel-dependencies.html" rel="prev" title="Kernel dependencies"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Building-the-kernel"></span><div class="header"> +<p> +Previous: <a href="Kernel-dependencies.html" accesskey="p" rel="prev">Kernel dependencies</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Building-the-kernel-1"></span><h4 class="subsection">1.4.3 Building the kernel</h4> + +<p>Next step is configuring and building the kernel. You can check Gentoo’s +<a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> to learn more about the matter. Overall, Gentoo Wiki +is a good place to learn about configuration according to your hardware. The +following will assume a monolithic kernel. +</p> +<div class="example"> +<pre class="example">make menuconfig +make +install -Dm755 $(make -s image_name) /boot/vmlinuz-linux +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Changing-Init-Program.html b/src/docs/Changing-Init-Program.html index 2948f40..d1cc7ce 100644 --- a/src/docs/Changing-Init-Program.html +++ b/src/docs/Changing-Init-Program.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Init-System.html" rel="up" title="Init System"> -<link href="Contribution-Guidelines.html" rel="next" title="Contribution Guidelines"> +<link href="Rebooting-after-changing-init.html" rel="next" title="Rebooting after changing init"> <link href="Init-Hooks.html" rel="prev" title="Init Hooks"> <style type="text/css"> <!-- @@ -48,57 +49,35 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Changing-Init-Program"></span><div class="header"> <p> -Previous: <a href="Init-Hooks.html" accesskey="p" rel="prev">Init Hooks</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="Configuring-Init.html" accesskey="p" rel="prev">Configuring Init</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Changing-Init-Program-1"></span><h3 class="section">3.3 Changing Init Program</h3> +<span id="Changing-Init-Program-1"></span><h3 class="section">2.2 Changing Init Program</h3> -<p>By default, Carbs Linux comes preinstalled with <code>busybox-init</code>, but this -can easily be replaced without any issues. Currently, available init systems are: +<p>By default, Carbs Linux comes preinstalled with ‘<samp>busybox-init</samp>’, but this can +easily be replaced without any issues. Currently, available init systems are: </p> <ul> -<li> sinit -</li><li> busybox -</li><li> runit -</li><li> shinit +<li> ‘<samp>sinit</samp>’ +</li><li> ‘<samp>busybox</samp>’ +</li><li> ‘<samp>runit</samp>’ +</li><li> ‘<samp>shinit</samp>’ </li></ul> <p>This example is for runit, but it will work with all init systems packaged in the -distribution repositories. See <a href="cpt_002dalternatives.html"><code>cpt-alternatives</code></a> +distribution repositories. See the ‘<samp>cpt-alternatives(1)</samp>’ manual page for more +details. </p> <div class="example"> -<pre class="example">$ cpt a runit /usr/bin/init -$ cpt a runit /usr/bin/poweroff -$ cpt a runit /usr/bin/reboot +<pre class="example">cpt a runit /usr/bin/init +cpt a runit /usr/bin/poweroff +cpt a runit /usr/bin/reboot </pre></div> - - -<span id="Rebooting-after-changing-Init"></span><h4 class="subsection">3.3.1 Rebooting after changing Init</h4> - -<p>After switching init systems, your running init system may not accept the -new poweroff commands. You will need to reboot/poweroff using the running init’s -utilities for the new utilities to work. These commands are for the init system -currently running on your system and not the one you are switching to. -</p> -<dl compact="compact"> -<dt><code>busybox</code></dt> -<dd><p><code>$ busybox reboot</code> -</p></dd> -<dt><code>runit</code></dt> -<dd><p><code>$ runit-init 6</code> -</p></dd> -<dt><code>shinit/sinit</code></dt> -<dd><p><code>$ kill -s INT 1</code> -</p></dd> -</dl> - - - - - - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Rebooting-after-changing-init.html" accesskey="1">Rebooting after changing init</a></td><td> </td><td align="left" valign="top">Ways to reboot after replacing the init system +</td></tr> +</table> diff --git a/src/docs/Chroot.html b/src/docs/Chroot.html index 6cfa061..c648361 100644 --- a/src/docs/Chroot.html +++ b/src/docs/Chroot.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="System-Configuration.html" rel="next" title="System Configuration"> -<link href="Preparing-Environment.html" rel="prev" title="Preparing Environment"> +<link href="Setting-up-repositories.html" rel="next" title="Setting up repositories"> +<link href="Obtain-the-chroot-helper.html" rel="prev" title="Obtain the chroot helper"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -56,178 +57,23 @@ Next: <a href="System-Configuration.html" accesskey="n" rel="next">System Config <p>Chroot into Carbs Linux! </p> <div class="example"> -<pre class="example">$ ./cpt-chroot /mnt +<pre class="example">./cpt-chroot /mnt </pre></div> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Setting-up-repositories.html" accesskey="1">Setting up repositories</a></td><td> </td><td align="left" valign="top">Basic setup for obtaining repositories +</td></tr> +<tr><td align="left" valign="top">• <a href="Updating-packages.html" accesskey="2">Updating packages</a></td><td> </td><td align="left" valign="top">Update your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Installing-packages.html" accesskey="3">Installing packages</a></td><td> </td><td align="left" valign="top">Install new software on your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Essential-Software.html" accesskey="4">Essential Software</a></td><td> </td><td align="left" valign="top">Software you might want to include on your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtaining-the-documentation.html" accesskey="5">Obtaining the documentation</a></td><td> </td><td align="left" valign="top">Install documentation for offline use (optional) +</td></tr> +</table> -<span id="Setting-up-repositories"></span><h4 class="subsection">1.2.1 Setting up repositories</h4> - -<p>Newest tarballs do not come with repositories, so you will need to manually -obtain them, and set your <code>CPT_PATH</code> environment variable. Carbs Linux -repositories can either be obtained by <code>git</code> or <code>rsync</code>. -While rsync repositories are overall faster and smaller, git offers the whole -history of the repository and a means to manipulate your repository as you like -it. If you want to obtain the git repository, you will need to install -<code>git</code> itself. -</p> -<p>The following guide will assume that you put the repositories into -<samp>~/repos/</samp> directory, but you can put the repositories into any directory -you want. So go ahead and create that directory: -</p> -<div class="example"> -<pre class="example">$ mkdir -p $HOME/repos -</pre></div> - - - -<span id="Obtaining-from-rsync"></span><h4 class="subsubsection">1.2.1.1 Obtaining from rsync</h4> - -<p>Carbs Linux rsync repositories live in <a href="rsync://carbslinux.org/repo">rsync://carbslinux.org/repo</a>. In -order to obtain it, run the following: -</p> -<div class="example"> -<pre class="example">$ rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs -</pre></div> - - - -<span id="Obtaining-from-git"></span><h4 class="subsubsection">1.2.1.2 Obtaining from git</h4> - -<p>Carbs Linux git repositories can be found both from the main server and GitHub -(mirror). Here are both their repository links. You can clone any of them. -</p> -<ul> -<li> <a href="git://git.carbslinux.org/repository">git://git.carbslinux.org/repository</a> -</li><li> <a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a> -</li></ul> - -<div class="example"> -<pre class="example">$ git clone git://git.carbslinux.org/repository $HOME/repos/carbs -</pre></div> - - - -<span id="Making-the-package-manager-use-the-repositories"></span><h4 class="subsubsection">1.2.1.3 Making the package manager use the repositories</h4> - -<p>In your shell’s configuration file, or in your <samp>~/.profile</samp> file, add the -following lines: -</p> -<div class="example"> -<pre class="example">export CPT_PATH='' -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/core -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg -CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community -export CPT_PATH -</pre></div> - - - -<span id="Updating-packages"></span><h4 class="subsection">1.2.2 Updating packages</h4> - -<p>It is good practice to make sure your system is up to date, especially before -building new packages. If there is an update for the package manager you will -need to update twice. -</p> -<div class="example"> -<pre class="example">$ cpt update -</pre></div> - - - -<span id="Installing-packages"></span><h4 class="subsection">1.2.3 Installing packages</h4> - -<p>Since you are operating on a really small base, you might need to build and -install new programs to extend the functionality of your system. In order to -build and install packages new packages in Carbs, you need to execute the -following. “Package” is not actually a package and is given as an example. -</p> -<div class="example"> -<pre class="example">$ cpt build package -$ cpt install package -</pre></div> - - - -<span id="Essential-Software"></span><h4 class="subsection">1.2.4 Essential Software</h4> - -<p>Here is a list of software that you might want to have on your system. -</p> -<p>BOOTLOADERS -</p><ul> -<li> efibootmgr -</li><li> grub -</li></ul> -<p>FILESYSTEMS -</p><ul> -<li> e2fsprogs -</li><li> dosfstools -</li><li> ntfs-3g -</li></ul> -<p>NETWORKING -</p><ul> -<li> dhcpcd -</li><li> wpa_supplicant -</li></ul> -<p>TEXT EDITORS -</p><ul> -<li> nano -</li><li> vim -</li><li> neatvi -</li><li> nvi -</li><li> emacs -</li><li> emacs-nox (terminal-only version of emacs) -</li></ul> -<p>USER SHELLS -</p><ul> -<li> bash -</li><li> zsh -</li><li> dash -</li><li> oksh -</li><li> rc -</li></ul> -<p>POSIX BASE UTILITIES -</p><ul> -<li> busybox -</li><li> sbase -</li><li> coreutils -</li></ul> -<p>DOCUMENTATION -</p><ul> -<li> carbs-docs -</li><li> man-pages -</li><li> man-pages-posix -</li></ul> - - - -<span id="Obtaining-the-documentation-_0028optional_0029"></span><h4 class="subsection">1.2.5 Obtaining the documentation (optional)</h4> - -<p>All the documentation for Carbs Linux can be found on a single info manual to be -viewed offline. You can obtain texinfo or the info (standalone) package in order -to view the documentation. -</p> -<div class="example"> -<pre class="example">Install the documentation. -$ cpt b carbs-docs && cpt i carbs-docs - -Install either texinfo or the info package. We will be installing standalone info -as it doesn't need perl. -$ cpt b info && cpt i info - -You can then run info and navigate through the documentation. -$ info carbslinux -</pre></div> - - - -<hr> -<div class="header"> -<p> -Next: <a href="System-Configuration.html" accesskey="n" rel="next">System Configuration</a>, Previous: <a href="Preparing-Environment.html" accesskey="p" rel="prev">Preparing Environment</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/src/docs/Configuring-Init.html b/src/docs/Configuring-Init.html index eddc1ac..93f7f35 100644 --- a/src/docs/Configuring-Init.html +++ b/src/docs/Configuring-Init.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Init-System.html" rel="up" title="Init System"> -<link href="Init-Hooks.html" rel="next" title="Init Hooks"> +<link href="Kernel-Command-Line.html" rel="next" title="Kernel Command Line"> <link href="Init-System.html" rel="prev" title="Init System"> <style type="text/css"> <!-- @@ -48,56 +49,27 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Configuring-Init"></span><div class="header"> <p> -Next: <a href="Init-Hooks.html" accesskey="n" rel="next">Init Hooks</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Changing-Init-Program.html" accesskey="n" rel="next">Changing Init Program</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Configuring-Init-1"></span><h3 class="section">3.1 Configuring Init</h3> +<span id="Configuring-Init-1"></span><h3 class="section">2.1 Configuring Init</h3> <p>There are three ways you can change the behaviour of the init system. Those are: </p> -<ol> +<ul> <li> Kernel Command Line -</li><li> <samp>/etc/init/rc.conf</samp> file +</li><li> ‘<samp>/etc/init/rc.conf</samp>’ file </li><li> Init Hooks -</li></ol> - - - -<span id="Kernel-Command-Line"></span><h4 class="subsection">3.1.1 Kernel Command Line</h4> - -<p>On GRUB, you can edit the kernel command line parameters, which will be parsed -as variables on the init system. Not all of the parameters will be acted upon, -but all of them will be set as variables on the init script. For example an -example command line, and how it is interpreted. -</p> -<div class="example"> -<pre class="example">BOOT_IMAGE=/boot/vmlinuz root=/dev/sda2 rw loglevel=3 quiet -</pre></div> - -<p>This command line will be parsed to set the following variables: -</p> -<div class="example"> -<pre class="example">BOOT_IMAGE=/boot/vmlinuz -root=/dev/sda2 -rw=1 -loglevel=3 -quiet=1 -</pre></div> - -<p>Some of these variables, such as <code>rw</code>/<code>ro</code>, <code>loglevel</code>, and -<code>quiet</code>, will be used by the init system to change the behaviour of the -startup. -</p> - - -<span id="g_t_002fetc_002finit_002frc_002econf-file"></span><h4 class="subsection">3.1.2 <samp>/etc/init/rc.conf</samp> file</h4> - -<p>However, the kernel command line isn’t the only place to set your boot -parameters. You can specify variables here as well, although note that the -kernel command line always gets the priority for these variables since they can -be set just before boot. -</p> - +</li></ul> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Kernel-Command-Line.html" accesskey="1">Kernel Command Line</a></td><td> </td><td align="left" valign="top">Configure init through the boot parameters +</td></tr> +<tr><td align="left" valign="top">• <a href="_002fetc_002finit_002frcconf-file.html" accesskey="2">‘<samp>/etc/init/rc.conf</samp>’ file</a></td><td> </td><td align="left" valign="top">Configure init through the configuration file +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-Hooks.html" accesskey="3">Init Hooks</a></td><td> </td><td align="left" valign="top">Configure init through hooks +</td></tr> +</table> diff --git a/src/docs/cpt_002dchecksum.html b/src/docs/Configuring-hostname.html index 8a038be..f4d4bee 100644 --- a/src/docs/cpt_002dchecksum.html +++ b/src/docs/Configuring-hostname.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-checksum (Carbs Linux User Manual)</title> +<title>Configuring hostname (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-checksum (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-checksum (Carbs Linux User Manual)"> +<meta name="description" content="Configuring hostname (Carbs Linux User Manual)"> +<meta name="keywords" content="Configuring hostname (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002ddownload.html" rel="next" title="cpt-download"> -<link href="cpt_002dbuild.html" rel="prev" title="cpt-build"> +<link href="System-Configuration.html" rel="up" title="System Configuration"> +<link href="Hosts-file.html" rel="next" title="Hosts file"> +<link href="System-Configuration.html" rel="prev" title="System Configuration"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,17 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dchecksum"></span><div class="header"> +<span id="Configuring-hostname"></span><div class="header"> <p> -Next: <a href="cpt_002ddownload.html" accesskey="n" rel="next"><code>cpt-download</code></a>, Previous: <a href="cpt_002dbuild.html" accesskey="p" rel="prev"><code>cpt-build</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Hosts-file.html" accesskey="n" rel="next">Hosts file</a>, Up: <a href="System-Configuration.html" accesskey="u" rel="up">System Configuration</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dchecksum-1"></span><h4 class="subsection">2.1.3 <code>cpt-checksum</code></h4> +<span id="Configuring-hostname-1"></span><h4 class="subsection">1.3.1 Configuring hostname</h4> -<p><code>cpt-checksum</code> will generate a <samp>checksums</samp> file from the package’s -sources. +<p>You might want to add a hostname, especially in a networked environment. Your +hostname will default to ’carbslinux’ unless you set this. </p> - +<div class="example"> +<pre class="example">echo your-hostname > /etc/hostname +</pre></div> diff --git a/src/docs/Contribution-Guidelines.html b/src/docs/Contribution-Guidelines.html index cbb7b02..5b2c7cf 100644 --- a/src/docs/Contribution-Guidelines.html +++ b/src/docs/Contribution-Guidelines.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> <link href="Conventions.html" rel="next" title="Conventions"> -<link href="Changing-Init-Program.html" rel="prev" title="Changing Init Program"> +<link href="Rebooting-after-changing-init.html" rel="prev" title="Rebooting after changing init"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -51,23 +52,19 @@ ul.no-bullet {list-style: none} Next: <a href="GNU-Free-Documentation-License.html" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="Init-System.html" accesskey="p" rel="prev">Init System</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Contribution-Guidelines-1"></span><h2 class="chapter">4 Contribution Guidelines</h2> +<span id="Contribution-Guidelines-1"></span><h2 class="chapter">3 Contribution Guidelines</h2> <p>Thanks for taking your time to contribute! To maintain stylistic behaviour throughout the repositories, one must adhere to these conventions. Exceptions and changes may occur with good reasoning. </p> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Conventions.html" accesskey="1">Conventions</a></td><td> </td><td align="left" valign="top">Distribution conventions -</td></tr> -<tr><td align="left" valign="top">• <a href="Sending-Git-mails.html" accesskey="2">Sending Git mails</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Conventions.html" accesskey="1">Conventions</a></td><td> </td><td align="left" valign="top">Conventions of the distribution </td></tr> </table> - - </body> </html> diff --git a/src/docs/Conventions.html b/src/docs/Conventions.html index 362292a..e1b3ac6 100644 --- a/src/docs/Conventions.html +++ b/src/docs/Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> -<link href="General-Conventions.html" rel="next" title="General Conventions"> +<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> <link href="Contribution-Guidelines.html" rel="prev" title="Contribution Guidelines"> <style type="text/css"> <!-- @@ -48,24 +49,48 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Conventions"></span><div class="header"> <p> -Next: <a href="Sending-Git-mails.html" accesskey="n" rel="next">Sending Git mails</a>, Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Conventions-1"></span><h3 class="section">4.1 Conventions</h3> +<span id="Conventions-1"></span><h3 class="section">3.1 Conventions</h3> + + + +<dl compact="compact"> +<dt>[<span id="g_t0010"></span>0010]</dt> +<dd><p>Try to keep the file readable. +</p><dl compact="compact"> +<dt>[<span id="g_t0011"></span>0011]</dt> +<dd><p>Characters on a line shouldn’t exceed 100 characters. +</p></dd> +<dt>[<span id="g_t0012"></span>0012]</dt> +<dd><p>Make sure you don’t have code commented out during +commit. Uncomment them or remove them completely. +</p></dd> +<dt>[<span id="g_t0013"></span>0013]</dt> +<dd><p>Do not add comments following the code, add them to the +top of the code. It makes it harder to read, and lines longer. Here is an example: +</p></dd> +</dl> + +<div class="example"> +<pre class="example"># Good way of commenting. +your code goes here + +your code goes here # Avoid this way of commenting. +</pre></div> +</dd> +</dl> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="General-Conventions.html" accesskey="1">General Conventions</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="2">Shell Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="1">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts </td></tr> -<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="3">Repository Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="2">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts </td></tr> </table> - - </body> </html> diff --git a/src/docs/Download.html b/src/docs/Download.html new file mode 100644 index 0000000..5d2a595 --- /dev/null +++ b/src/docs/Download.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Download (Carbs Linux User Manual)</title> + +<meta name="description" content="Download (Carbs Linux User Manual)"> +<meta name="keywords" content="Download (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Signature-verification.html" rel="next" title="Signature verification"> +<link href="Preparing-Environment.html" rel="prev" title="Preparing Environment"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Download"></span><div class="header"> +<p> +Next: <a href="Signature-verification.html" accesskey="n" rel="next">Signature verification</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Download-1"></span><h4 class="subsection">1.1.1 Download</h4> + +<p>First, we need to download the rootfs tarball. You can do the following in order +to obtain the rootfs. If you are using an i686 machine, replace the ‘<samp>x86_64</samp>’ +with ‘<samp>i686</samp>’. We are setting this in a URL variable so that we don’t have to +write it every time. +</p> +<div class="example"> +<pre class="example">wget $URL/carbs-rootfs.tar.xz.sha256 +sha256sum -c carbs-rootfs.tar.xz.sha256 +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Editing-the-build-file-during-pre_002dbuild.html b/src/docs/Editing-the-build-file-during-pre_002dbuild.html deleted file mode 100644 index 7955ddb..0000000 --- a/src/docs/Editing-the-build-file-during-pre_002dbuild.html +++ /dev/null @@ -1,93 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Editing the build file during pre-build (Carbs Linux User Manual)</title> - -<meta name="description" content="Editing the build file during pre-build (Carbs Linux User Manual)"> -<meta name="keywords" content="Editing the build file during pre-build (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Hooks.html" rel="up" title="Hooks"> -<link href="Packaging-System.html" rel="next" title="Packaging System"> -<link href="Hooks.html" rel="prev" title="Hooks"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Editing-the-build-file-during-pre_002dbuild"></span><div class="header"> -<p> -Up: <a href="Hooks.html" accesskey="u" rel="up">Hooks</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Editing-the-build-file-during-pre_002dbuild-1"></span><h4 class="subsection">2.3.1 Editing the <samp>build</samp> file during pre-build</h4> - -<p>You can edit the <samp>build</samp> file during pre-build. The file is copied from the -repository to the build directory named as <samp>.build.cpt</samp>. You can use -<code>sed</code> or any other tool to edit the build file. After the build is -complete, a <code>diff</code> file will be placed to the package database named as -<samp>build.diff</samp>. Here is an example <samp>build</samp> file manipulation during the -pre-build hook. -</p> -<div class="example"> -<pre class="example">cat <<EOF> .build.cpt -#!/bin/sh -e - -for patch in bash50-0??; do - patch -p0 < "\$patch" -done - -export LDFLAGS=-static - -./configure \ - --prefix=/usr \ - --without-bash-malloc \ - --disable-nls - -export MAKEFLAGS="TERMCAP_LIB=/usr/lib/libncursesw.a $MAKEFLAGS" - -make -make DESTDIR="\$1" install - -ln -s bash "\$1/usr/bin/sh" -EOF -</pre></div> - - - - - - -</body> -</html> diff --git a/src/docs/Environment-Variables.html b/src/docs/Environment-Variables.html deleted file mode 100644 index b47dfd6..0000000 --- a/src/docs/Environment-Variables.html +++ /dev/null @@ -1,184 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Environment Variables (Carbs Linux User Manual)</title> - -<meta name="description" content="Environment Variables (Carbs Linux User Manual)"> -<meta name="keywords" content="Environment Variables (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Hooks.html" rel="next" title="Hooks"> -<link href="cpt_002dupdate.html" rel="prev" title="cpt-update"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Environment-Variables"></span><div class="header"> -<p> -Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Environment-Variables-1"></span><h3 class="section">2.2 Environment Variables</h3> - -<p>Since there is no configuration file for cpt, the package manager is configured -through environment variables. These can be set per operation, or be set to your -shell configuration or <samp>~/.profile</samp>. Here are the environment variables that -alter the behaviour of <code>cpt</code>: -</p> -<dl compact="compact"> -<dt><code>CPT_PATH</code></dt> -<dd><p>Set the locations of your repositories. This is set similar to the <code>PATH</code> -variable. -</p> -</dd> -<dt><code>XDG_CACHE_HOME</code></dt> -<dd><p>Unless this is set, the <samp>~/.cache</samp> directory will be used instead. -</p> -</dd> -<dt><code>CPT_CACHE</code></dt> -<dd><p>The cache directory for <code>cpt</code>. Default: <samp>$XDG_CACHE_HOME/cpt</samp> -</p> -</dd> -<dt><code>CPT_CHOICE</code></dt> -<dd><p>If this is set to 0, a package installation will be aborted on conflicts. -Default: 1 -</p> -</dd> -<dt><code>CPT_COMPRESS</code></dt> -<dd><p>Program used to compress package tarballs. The values should be the default -suffixes for the program. Available values are: -</p> -<ul> -<li> <code>gz</code> -</li><li> <code>zst</code> -</li><li> <code>bz2</code> -</li><li> <code>xz</code> -</li></ul> -<p>Default: <code>gz</code> -</p> -</dd> -<dt><code>CPT_DEBUG</code></dt> -<dd><p>If this is set to 1, temporary build directories will not be removed after the -given operation. Default: unset -</p> -</dd> -<dt><code>CPT_FETCH</code></dt> -<dd><p>If this is set to 0, <code>cpt-update</code> will not fetch the repositories. -This behaviour can also be achieved by adding <samp>-n</samp> or <samp>--no-fetch</samp> -as an argument. Default: 0 -</p> -</dd> -<dt><code><span id="cptforce"></span>CPT_FORCE</code></dt> -<dd><p>If this is set to 1, some of the <code>cpt</code> tools will continue regardless of -errors or skip certain checks. Here are some examples: -</p> -<ul> -<li> <code>cpt-install</code> will install a package without verifying its manifest. -</li><li> <code>cpt-install</code> will install a package even when there are missing -dependencies. -</li><li> <code>cpt-remove</code> will remove packages even when there are other packages -that depend on the current package. -</li></ul> - -<p>This behaviour can also be achieved by adding <samp>-f</samp> or <samp>--force</samp> -as an argument to those utilities. -</p> -<p>Default: 0 -</p> -</dd> -<dt><code>CPT_HOOK</code></dt> -<dd><p>Location for the hook file See <a href="Hooks.html">Hooks</a>. Default: unset -</p> -</dd> -<dt><code>CPT_KEEPLOG</code></dt> -<dd><p>Normally, logs are deleted if the package is built successfully. If set to 1, -logs will be kept even when the packages are built as intended. Default: 0 -</p> -</dd> -<dt><code>CPT_PID</code></dt> -<dd><p>If this variable is set, the temporary files will be created with this variable -as the suffix, instead of the PID of the <code>cpt</code> process. The advantage -is that you can know exactly where the build directory is located, while the -disadvantage is that there will be issues with multiple operations at the -same time. So the best way to use this variable is during one-time <code>cpt</code> -calls. -</p> -<div class="example"> -<pre class="example">CPT_PID=mesa cpt b mesa -</pre></div> - -<p>By running the above, you will know that the created build directories will end -with the <tt>*-mesa</tt> suffix. -</p> -</dd> -<dt><code>CPT_PROMPT</code></dt> -<dd><p>If set to 0, the package manager will not prompt you for anything and will -continue with the default action. This behaviour can also be achieved by adding <samp>-y</samp> or <samp>--no-prompt</samp> -as an argument to some utilities. -Default: 1 -</p> -</dd> -<dt><code><span id="cptroot"></span>CPT_ROOT</code></dt> -<dd><p>If this variable is set, <code>cpt</code> will assume this as the system root, and -will install/remove/update/list packages assuming this is the system root. -This behaviour can also be achieved by adding <samp>--root</samp> as an argument to some utilities. -</p> -</dd> -<dt><code>CPT_TEST</code></dt> -<dd><p>If set to 1, <code>cpt-build</code> will run tests where a package has the -<samp>test</samp> build file. This behaviour can also be achieved by adding <samp>-t</samp> or <samp>--test</samp> -as an argument to <code>cpt-build</code>. Default: 0 -</p> -</dd> -<dt><code>CPT_TMPDIR</code></dt> -<dd><p>The directory to create the build files. This can be changed (for example to -/tmp) for building on RAM, saving SSD space, etc. Default: <code>$CPT_CACHE</code> -</p> -</dd> -</dl> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/src/docs/Essential-Software.html b/src/docs/Essential-Software.html new file mode 100644 index 0000000..3910e9b --- /dev/null +++ b/src/docs/Essential-Software.html @@ -0,0 +1,120 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Essential Software (Carbs Linux User Manual)</title> + +<meta name="description" content="Essential Software (Carbs Linux User Manual)"> +<meta name="keywords" content="Essential Software (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Obtaining-the-documentation.html" rel="next" title="Obtaining the documentation"> +<link href="Installing-packages.html" rel="prev" title="Installing packages"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Essential-Software"></span><div class="header"> +<p> +Next: <a href="Obtaining-the-documentation.html" accesskey="n" rel="next">Obtaining the documentation</a>, Previous: <a href="Installing-packages.html" accesskey="p" rel="prev">Installing packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Essential-Software-1"></span><h4 class="subsection">1.2.4 Essential Software</h4> + +<p>Here is a list of software that you might want to have on your system. +</p> +<p><strong>BOOTLOADERS</strong> +</p> +<ul> +<li> efibootmgr +</li><li> grub +</li></ul> + +<p><strong>FILESYSTEMS</strong> +</p> +<ul> +<li> e2fsprogs +</li><li> dosfstools +</li><li> ntfs-3g +</li></ul> + +<p><strong>NETWORKING</strong> +</p> +<ul> +<li> dhcpcd +</li><li> wpa<em>_supplicant</em> +</li></ul> + +<p><strong>TEXT EDITORS</strong> +</p> +<ul> +<li> nano +</li><li> vim +</li><li> neatvi +</li><li> emacs +</li><li> emacs-nox (terminal-only version of emacs) +</li></ul> + +<p><strong>USER SHELLS</strong> +</p> +<ul> +<li> bash +</li><li> zsh +</li><li> oksh +</li><li> rc +</li></ul> + +<p><strong>POSIX BASE UTILITIES</strong> +</p> +<ul> +<li> busybox +</li><li> sbase +</li><li> coreutils +</li></ul> + +<p><strong>DOCUMENTATION</strong> +</p> +<ul> +<li> carbs-docs +</li><li> man-pages +</li><li> man-pages-posix +</li></ul> + + + + +</body> +</html> diff --git a/src/docs/Extracting-the-tarball.html b/src/docs/Extracting-the-tarball.html new file mode 100644 index 0000000..8659608 --- /dev/null +++ b/src/docs/Extracting-the-tarball.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Extracting the tarball (Carbs Linux User Manual)</title> + +<meta name="description" content="Extracting the tarball (Carbs Linux User Manual)"> +<meta name="keywords" content="Extracting the tarball (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Obtain-the-chroot-helper.html" rel="next" title="Obtain the chroot helper"> +<link href="Signature-verification.html" rel="prev" title="Signature verification"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Extracting-the-tarball"></span><div class="header"> +<p> +Next: <a href="Obtain-the-chroot-helper.html" accesskey="n" rel="next">Obtain the chroot helper</a>, Previous: <a href="Signature-verification.html" accesskey="p" rel="prev">Signature verification</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Extracting-the-tarball-1"></span><h4 class="subsection">1.1.3 Extracting the tarball</h4> + +<p>You will need to extract the tarball to your desired location. For partitioning, +you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. This will assume that you will be mounting your root +partition to ‘<samp>/mnt</samp>’. +</p> +<div class="example"> +<pre class="example">mount /dev/sdx1 /mnt +tar xf carbs-rootfs.tar.xz -C /mnt +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Fstab.html b/src/docs/Fstab.html new file mode 100644 index 0000000..d4573ec --- /dev/null +++ b/src/docs/Fstab.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Fstab (Carbs Linux User Manual)</title> + +<meta name="description" content="Fstab (Carbs Linux User Manual)"> +<meta name="keywords" content="Fstab (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Post_002dinstallation.html" rel="next" title="Post-installation"> +<link href="Init-scripts.html" rel="prev" title="Init scripts"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Fstab"></span><div class="header"> +<p> +Previous: <a href="Init-scripts.html" accesskey="p" rel="prev">Init scripts</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Fstab-1"></span><h4 class="subsection">1.5.3 Fstab</h4> + +<p>You can now manually edit your fstab entry, or you can use the genfstab tool. +If you want to use the tool, exit the chroot and run the following: +</p> +<div class="example"> +<pre class="example">wget https://github.com/cemkeylan/genfstab/raw/master/genfstab +chmod +x genfstab +./genfstab -U /mnt >> /mnt/etc/fstab +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/GNU-Free-Documentation-License.html b/src/docs/GNU-Free-Documentation-License.html index 9b9be9d..4fb6747 100644 --- a/src/docs/GNU-Free-Documentation-License.html +++ b/src/docs/GNU-Free-Documentation-License.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> -<link href="Sending-Git-mails.html" rel="prev" title="Sending Git mails"> +<link href="Repository-Conventions.html" rel="prev" title="Repository Conventions"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -50,14 +51,13 @@ ul.no-bullet {list-style: none} Previous: <a href="Contribution-Guidelines.html" accesskey="p" rel="prev">Contribution Guidelines</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="GNU-Free-Documentation-License-1"></span><h2 class="unnumbered">GNU Free Documentation License</h2> +<span id="GNU-Free-Documentation-License-1"></span><h2 class="appendix">Appendix A GNU Free Documentation License</h2> <div align="center">Version 1.3, 3 November 2008 </div> - <div class="display"> <pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -<a href="https://fsf.org/">https://fsf.org/</a> +<a href="http://fsf.org/">http://fsf.org/</a> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -67,190 +67,197 @@ of this license document, but changing it is not allowed. <li> PREAMBLE <p>The purpose of this License is to make a manual, textbook, or other -functional and useful document <em>free</em> in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. -</p> -<p>This License is a kind of “copyleft”, which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft +functional and useful document <em>free</em> +in the sense of freedom: to assure everyone the effective freedom +to copy and redistribute it, with or without modifying it, either +commercially or noncommercially. Secondarily, this License +preserves for the author and publisher a way to get credit for +their work, while not being considered responsible for +modifications made by others. +</p> +<p>This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. +It complements the GNU General Public License, which is a copyleft license designed for free software. </p> -<p>We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. +<p>We have designed this License in order to use it for manuals for +free software, because free software needs free documentation: +a free program should come with manuals providing the same freedoms +that the software does. But this License is not limited to +software manuals; it can be used for any textual work, regardless +of subject matter or whether it is published as a printed book. We +recommend this License principally for works whose purpose is +instruction or reference. </p> </li><li> APPLICABILITY AND DEFINITIONS -<p>This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The “Document”, below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as “you”. You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. -</p> -<p>A “Modified Version” of the Document means any work containing the +<p>This License applies to any manual or other work, in any medium, +that contains a notice placed by the copyright holder saying it can +be distributed under the terms of this License. Such a notice +grants a world-wide, royalty-free license, unlimited in duration, +to use that work under the conditions stated herein. The +"Document", below, refers to any such manual or work. Any member +of the public is a licensee, and is addressed as "you". You accept +the license if you copy, modify or distribute the work in a way +requiring permission under copyright law. +</p> +<p>A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. </p> -<p>A “Secondary Section” is a named appendix or a front-matter section +<p>A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. -</p> -<p>The “Invariant Sections” are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. -</p> -<p>The “Cover Texts” are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. -</p> -<p>A “Transparent” copy of the Document means a machine-readable copy, +subject (or to related matters) and contains nothing that could +fall directly within that overall subject. (Thus, if the Document +is in part a textbook of mathematics, a Secondary Section may not +explain any mathematics.) The relationship could be a matter of +historical connection with the subject or with related matters, or +of legal, commercial, philosophical, ethical or political position +regarding them. +</p> +<p>The "Invariant Sections" are certain Secondary Sections whose +titles are designated, as being those of Invariant Sections, in the +notice that says that the Document is released under this License. +If a section does not fit the above definition of Secondary then it +is not allowed to be designated as Invariant. The Document may +contain zero Invariant Sections. If the Document does not identify +any Invariant Sections then there are none. +</p> +<p>The "Cover Texts" are certain short passages of text that are +listed, as Front-Cover Texts or Back-Cover Texts, in the notice +that says that the Document is released under this License. +A Front-Cover Text may be at most 5 words, and a Back-Cover Text +may be at most 25 words. +</p> +<p>A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not “Transparent” is called “Opaque”. +straightforwardly with generic text editors or (for images composed +of pixels) generic paint programs or (for drawings) some widely +available drawing editor, and that is suitable for input to text +formatters or for automatic translation to a variety of formats +suitable for input to text formatters. A copy made in an otherwise +Transparent file format whose markup, or absence of markup, has +been arranged to thwart or discourage subsequent modification by +readers is not Transparent. An image format is not Transparent if +used for any substantial amount of text. A copy that is not +"Transparent" is called "Opaque". </p> <p>Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input -format, SGML or XML using a publicly available -DTD, and standard-conforming simple HTML, -PostScript or PDF designed for human modification. Examples -of transparent image formats include PNG, XCF and -JPG. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, SGML or -XML for which the DTD and/or processing tools are -not generally available, and the machine-generated HTML, -PostScript or PDF produced by some word processors for -output purposes only. -</p> -<p>The “Title Page” means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, “Title Page” means -the text near the most prominent appearance of the work’s title, -preceding the beginning of the body of the text. -</p> -<p>The “publisher” means any person or entity that distributes copies +ASCII without markup, Texinfo input format, LaTeX input format, +SGML or XML using a publicly available DTD, and standard-conforming +simple HTML, PostScript or PDF designed for human modification. +Examples of transparent image formats include PNG, XCF and JPG. +Opaque formats include proprietary formats that can be read and +edited only by proprietary word processors, SGML or XML for which +the DTD and/or processing tools are not generally available, and +the machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. +</p> +<p>The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the +material this License requires to appear in the title page. For +works in formats which do not have any title page as such, "Title +Page" means the text near the most prominent appearance of the +work’s title, preceding the beginning of the body of the text. +</p> +<p>The "publisher" means any person or entity that distributes copies of the Document to the public. </p> -<p>A section “Entitled XYZ” means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as “Acknowledgements”, -“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” -of such a section when you modify the Document means that it remains a -section “Entitled XYZ” according to this definition. -</p> -<p>The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. +<p>A section "Entitled XYZ" means a named subunit of the Document +whose title either is precisely XYZ or contains XYZ in parentheses +following text that translates XYZ in another language. (Here XYZ +stands for a specific section name mentioned below, such as +"Acknowledgements", "Dedications", "Endorsements", or "History".) +To "Preserve the Title" of such a section when you modify the +Document means that it remains a section "Entitled XYZ" according +to this definition. +</p> +<p>The Document may include Warranty Disclaimers next to the notice +which states that this License applies to the Document. These +Warranty Disclaimers are considered to be included by reference in +this License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and +has no effect on the meaning of this License. </p> </li><li> VERBATIM COPYING <p>You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. -</p> -<p>You may also lend copies, under the same conditions stated above, and -you may publicly display copies. +copyright notices, and the license notice saying this License +applies to the Document are reproduced in all copies, and that you +add no other conditions whatsoever to those of this License. You +may not use technical measures to obstruct or control the reading +or further copying of the copies you make or distribute. However, +you may accept compensation in exchange for copies. If you +distribute a large enough number of copies you must also follow the +conditions in section 3. +</p> +<p>You may also lend copies, under the same conditions stated above, +and you may publicly display copies. </p> </li><li> COPYING IN QUANTITY -<p>If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document’s license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. +<p>If you publish printed copies (or copies in media that commonly +have printed covers) of the Document, numbering more than 100, and +the Document’s license notice requires Cover Texts, you must +enclose the copies in covers that carry, clearly and legibly, all +these Cover Texts: Front-Cover Texts on the front cover, and +Back-Cover Texts on the back cover. Both covers must also clearly +and legibly identify you as the publisher of these copies. The +front cover must present the full title with all words of the title +equally prominent and visible. You may add other material on the +covers in addition. Copying with changes limited to the covers, as +long as they preserve the title of the Document and satisfy these +conditions, can be treated as verbatim copying in other respects. </p> <p>If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. -</p> -<p>If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. -</p> -<p>It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. +reasonably) on the actual cover, and continue the rest onto +adjacent pages. +</p> +<p>If you publish or distribute Opaque copies of the Document +numbering more than 100, you must either include a machine-readable +Transparent copy along with each Opaque copy, or state in or with +each Opaque copy a computer-network location from which the general +network-using public has access to download using public-standard +network protocols a complete Transparent copy of the Document, free +of added material. If you use the latter option, you must take +reasonably prudent steps, when you begin distribution of Opaque +copies in quantity, to ensure that this Transparent copy will +remain thus accessible at the stated location until at least one +year after the last time you distribute an Opaque copy (directly or +through your agents or retailers) of that edition to the public. +</p> +<p>It is requested, but not required, that you contact the authors of +the Document well before redistributing any large number of copies, +to give them a chance to provide you with an updated version of the +Document. </p> </li><li> MODIFICATIONS -<p>You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: +<p>You may copy and distribute a Modified Version of the Document +under the conditions of sections 2 and 3 above, provided that you +release the Modified Version under precisely this License, with the +Modified Version filling the role of the Document, thus licensing +distribution and modification of the Modified Version to whoever +possesses a copy of it. In addition, you must do these things in +the Modified Version: </p> <ol type="A" start="1"> -<li> Use in the Title Page (and on the covers, if any) a title distinct -from that of the Document, and from those of previous versions -(which should, if there were any, be listed in the History section -of the Document). You may use the same title as a previous version -if the original publisher of that version gives permission. - -</li><li> List on the Title Page, as authors, one or more persons or entities -responsible for authorship of the modifications in the Modified -Version, together with at least five of the principal authors of the -Document (all of its principal authors, if it has fewer than five), -unless they release you from this requirement. +<li> Use in the Title Page (and on the covers, if any) a title +distinct from that of the Document, and from those of previous +versions (which should, if there were any, be listed in the +History section of the Document). You may use the same title as +a previous version if the original publisher of that version +gives permission. + +</li><li> List on the Title Page, as authors, one or more persons or +entities responsible for authorship of the modifications in the +Modified Version, together with at least five of the principal +authors of the Document (all of its principal authors, if it has +fewer than five), unless they release you from this requirement. </li><li> State on the Title page the name of the publisher of the Modified Version, as the publisher. @@ -260,45 +267,50 @@ Modified Version, as the publisher. </li><li> Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. -</li><li> Include, immediately after the copyright notices, a license notice -giving the public permission to use the Modified Version under the -terms of this License, in the form shown in the Addendum below. +</li><li> Include, immediately after the copyright notices, a license +notice giving the public permission to use the Modified Version +under the terms of this License, in the form shown in the +Addendum below. -</li><li> Preserve in that license notice the full lists of Invariant Sections -and required Cover Texts given in the Document’s license notice. +</li><li> Preserve in that license notice the full lists of Invariant +Sections and required Cover Texts given in the Document’s +license notice. </li><li> Include an unaltered copy of this License. -</li><li> Preserve the section Entitled “History”, Preserve its Title, and add -to it an item stating at least the title, year, new authors, and -publisher of the Modified Version as given on the Title Page. If -there is no section Entitled “History” in the Document, create one -stating the title, year, authors, and publisher of the Document as -given on its Title Page, then add an item describing the Modified -Version as stated in the previous sentence. - -</li><li> Preserve the network location, if any, given in the Document for -public access to a Transparent copy of the Document, and likewise -the network locations given in the Document for previous versions -it was based on. These may be placed in the “History” section. -You may omit a network location for a work that was published at -least four years before the Document itself, or if the original -publisher of the version it refers to gives permission. - -</li><li> For any section Entitled “Acknowledgements” or “Dedications”, Preserve -the Title of the section, and preserve in the section all the -substance and tone of each of the contributor acknowledgements and/or -dedications given therein. - -</li><li> Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers -or the equivalent are not considered part of the section titles. - -</li><li> Delete any section Entitled “Endorsements”. Such a section -may not be included in the Modified Version. - -</li><li> Do not retitle any existing section to be Entitled “Endorsements” or -to conflict in title with any Invariant Section. +</li><li> Preserve the section Entitled "History", Preserve its Title, and +add to it an item stating at least the title, year, new authors, +and publisher of the Modified Version as given on the Title +Page. If there is no section Entitled "History" in the Document, +create one stating the title, year, authors, and publisher of +the Document as given on its Title Page, then add an item +describing the Modified Version as stated in the previous +sentence. + +</li><li> Preserve the network location, if any, given in the Document +for public access to a Transparent copy of the Document, and +likewise the network locations given in the Document for +previous versions it was based on. These may be placed in the +"History" section. You may omit a network location for a work +that was published at least four years before the Document +itself, or if the original publisher of the version it refers +to gives permission. + +</li><li> For any section Entitled "Acknowledgements" or "Dedications", +Preserve the Title of the section, and preserve in the section +all the substance and tone of each of the contributor +acknowledgements and/or dedications given therein. + +</li><li> Preserve all the Invariant Sections of the Document, unaltered +in their text and in their titles. Section numbers or the +equivalent are not considered part of the section titles. + +</li><li> Delete any section Entitled "Endorsements". Such a section may +not be included in the Modified Version. + +</li><li> Do not retitle any existing section to be Entitled +"Endorsements" or to conflict in title with any Invariant +Section. </li><li> Preserve any Warranty Disclaimers. </li></ol> @@ -310,7 +322,7 @@ of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles. </p> -<p>You may add a section Entitled “Endorsements”, provided it contains +<p>You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a @@ -332,182 +344,188 @@ imply endorsement of any Modified Version. </p> </li><li> COMBINING DOCUMENTS -<p>You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. +<p>You may combine the Document with other documents released under +this License, under the terms defined in section 4 above for +modified versions, provided that you include in the combination all +of the Invariant Sections of all of the original documents, +unmodified, and list them all as Invariant Sections of your +combined work in its license notice, and that you preserve all +their Warranty Disclaimers. </p> <p>The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. -</p> -<p>In the combination, you must combine any sections Entitled “History” -in the various original documents, forming one section Entitled -“History”; likewise combine any sections Entitled “Acknowledgements”, -and any sections Entitled “Dedications”. You must delete all -sections Entitled “Endorsements.” +copy. If there are multiple Invariant Sections with the same name +but different contents, make the title of each such section unique +by adding at the end of it, in parentheses, the name of the +original author or publisher of that section if known, or else +a unique number. Make the same adjustment to the section titles in +the list of Invariant Sections in the license notice of the +combined work. +</p> +<p>In the combination, you must combine any sections Entitled +"History" in the various original documents, forming one section +Entitled "History"; likewise combine any sections Entitled +"Acknowledgements", and any sections Entitled "Dedications". You +must delete all sections Entitled "Endorsements." </p> </li><li> COLLECTIONS OF DOCUMENTS -<p>You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. +<p>You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the +rules of this License for verbatim copying of each of the documents +in all other respects. </p> -<p>You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. +<p>You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert +a copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. </p> </li><li> AGGREGATION WITH INDEPENDENT WORKS -<p>A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an “aggregate” if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation’s users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. +<p>A compilation of the Document or its derivatives with other +separate and independent documents or works, in or on a volume of +a storage or distribution medium, is called an "aggregate" if the +copyright resulting from the compilation is not used to limit the +legal rights of the compilation’s users beyond what the individual +works permit. When the Document is included in an aggregate, this +License does not apply to the other works in the aggregate which +are not themselves derivative works of the Document. </p> <p>If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document’s Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. +copies of the Document, then if the Document is less than one half +of the entire aggregate, the Document’s Cover Texts may be placed +on covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic +form. Otherwise they must appear on printed covers that bracket +the whole aggregate. </p> </li><li> TRANSLATION <p>Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. -</p> -<p>If a section in the Document is Entitled “Acknowledgements”, -“Dedications”, or “History”, the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. +distribute translations of the Document under the terms of +section 4. Replacing Invariant Sections with translations requires +special permission from their copyright holders, but you may +include translations of some or all Invariant Sections in addition +to the original versions of these Invariant Sections. You may +include a translation of this License, and all the license notices +in the Document, and any Warranty Disclaimers, provided that you +also include the original English version of this License and the +original versions of those notices and disclaimers. In case of +a disagreement between the translation and the original version of +this License or a notice or disclaimer, the original version will +prevail. +</p> +<p>If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to +Preserve its Title (section 1) will typically require changing the +actual title. </p> </li><li> TERMINATION <p>You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. +otherwise to copy, modify, sublicense, or distribute it is void, +and will automatically terminate your rights under this License. </p> -<p>However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. +<p>However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the +copyright holder fails to notify you of the violation by some +reasonable means prior to 60 days after the cessation. </p> <p>Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. +received notice of violation of this License (for any work) from +that copyright holder, and you cure the violation prior to 30 days +after your receipt of the notice. </p> -<p>Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. +<p>Termination of your rights under this section does not terminate +the licenses of parties who have received copies or rights from you +under this License. If your rights have been terminated and not +permanently reinstated, receipt of a copy of some or all of the +same material does not give you any rights to use it. </p> </li><li> FUTURE REVISIONS OF THIS LICENSE -<p>The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new +<p>The Free Software Foundation may publish new, revised versions of +the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See -<a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>. -</p> -<p>Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License “or any later version” applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy’s public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. +<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>. +</p> +<p>Each version of the License is given a distinguishing version +number. If the Document specifies that a particular numbered +version of this License "or any later version" applies to it, you +have the option of following the terms and conditions either of +that specified version or of any later version that has been +published (not as a draft) by the Free Software Foundation. If +the Document does not specify a version number of this License, +you may choose any version ever published (not as a draft) by the +Free Software Foundation. If the Document specifies that a proxy +can decide which future versions of this License can be used, that +proxy’s public statement of acceptance of a version permanently +authorizes you to choose that version for the Document. </p> </li><li> RELICENSING -<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +<p>"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -“Massive Multiauthor Collaboration” (or “MMC”) contained in the -site means any set of copyrightable works thus published on the MMC -site. -</p> -<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. -</p> -<p>“Incorporate” means to publish or republish a Document, in whole or -in part, as part of another Document. -</p> -<p>An MMC is “eligible for relicensing” if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole -or in part into the MMC, (1) had no cover texts or invariant sections, -and (2) were thus incorporated prior to November 1, 2008. -</p> -<p>The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. +provides prominent facilities for anybody to edit those works. +A public wiki that anybody can edit is an example of such +a server. A "Massive Multiauthor Collaboration" (or "MMC") +contained in the site means any set of copyrightable works thus +published on the MMC site. </p> -</li></ol> +<p>"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, +a not-for-profit corporation with a principal place of business in +San Francisco, California, as well as future copyleft versions of +that license published by that same organization. +</p> +<p>"Incorporate" means to publish or republish a Document, in whole +or in part, as part of another Document. +</p> +<p>An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this +License somewhere other than this MMC, and subsequently +incorporated in whole or in part into the MMC, (1) had no cover +texts or invariant sections, and (2) were thus incorporated prior +to November 1, 2008. +</p> +<p>The operator of an MMC Site may republish an MMC contained in the +site under CC-BY-SA on the same site at any time before August 1, +2009, provided the MMC is eligible for relicensing. +</p></li></ol> + -<span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="heading">ADDENDUM: How to use this License for your documents</h3> +<span id="ADDENDUM-How-to-use-this-License-for-your-documents"></span><span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="appendixsec">A.1 ADDENDUM: How to use this License for your documents</h3> <p>To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: </p> <div class="example"> -<pre class="example"> Copyright (C) <var>year</var> <var>your name</var>. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. +<pre class="example">Copyright (C) YEAR YOUR NAME. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 +or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover +Texts. A copy of the license is included in the section entitled ``GNU +Free Documentation License''. </pre></div> <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the “with…Texts.” line with this: +replace the "with…Texts." line with this: </p> <div class="example"> -<pre class="example"> with the Invariant Sections being <var>list their titles</var>, with - the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts - being <var>list</var>. +<pre class="example">with the Invariant Sections being LIST THEIR TITLES, with +the Front-Cover Texts being LIST, and with the Back-Cover Texts +being LIST. </pre></div> <p>If you have Invariant Sections without Cover Texts, or some other @@ -516,12 +534,9 @@ situation. </p> <p>If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. +free software license, such as the GNU General Public License, to +permit their use in free software. </p> - - - <hr> <div class="header"> <p> diff --git a/src/docs/General-Conventions.html b/src/docs/General-Conventions.html deleted file mode 100644 index e3591dc..0000000 --- a/src/docs/General-Conventions.html +++ /dev/null @@ -1,87 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>General Conventions (Carbs Linux User Manual)</title> - -<meta name="description" content="General Conventions (Carbs Linux User Manual)"> -<meta name="keywords" content="General Conventions (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Conventions.html" rel="up" title="Conventions"> -<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> -<link href="Conventions.html" rel="prev" title="Conventions"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="General-Conventions"></span><div class="header"> -<p> -Next: <a href="Shell-Conventions.html" accesskey="n" rel="next">Shell Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="General-Conventions-_002d_002d-00"></span><h4 class="subsection">4.1.1 General Conventions – 00</h4> - -<dl compact="compact"> -<dt><strong>[<span id="g_t0010"></span>0010]</strong></dt> -<dd><p>Try to keep the file readable. -</p><dl compact="compact"> -<dt><strong>[<span id="g_t0011"></span>0011]</strong></dt> -<dd><p>Characters on a line shouldn’t exceed 100 characters. -</p></dd> -<dt><strong>[<span id="g_t0012"></span>0012]</strong></dt> -<dd><p>Make sure you don’t have code commented out during commit. Uncomment them -or remove them completely. -</p></dd> -<dt><strong>[<span id="g_t0013"></span>0013]</strong></dt> -<dd><p>Do not add comments following the code, add them to the top of the code. It -makes it harder to read, and lines longer. Here is an example: -</p><div class="example"> -<pre class="example"># Good way of commenting. -your code goes here - -your code goes here # Avoid this way of commenting. -</pre></div> -</dd> -</dl> -</dd> -</dl> - - - - - - -</body> -</html> diff --git a/src/docs/Hooks.html b/src/docs/Hooks.html deleted file mode 100644 index e78cbf9..0000000 --- a/src/docs/Hooks.html +++ /dev/null @@ -1,103 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Hooks (Carbs Linux User Manual)</title> - -<meta name="description" content="Hooks (Carbs Linux User Manual)"> -<meta name="keywords" content="Hooks (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Editing-the-build-file-during-pre_002dbuild.html" rel="next" title="Editing the build file during pre-build"> -<link href="Environment-Variables.html" rel="prev" title="Environment Variables"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Hooks"></span><div class="header"> -<p> -Next: <a href="Packaging-System.html" accesskey="n" rel="next">Packaging System</a>, Previous: <a href="Environment-Variables.html" accesskey="p" rel="prev">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Hooks-1"></span><h3 class="section">2.3 Hooks</h3> - -<p>Hooks can be used in order to change the runtime behaviour of the package manager. -There are a variety of package hooks, mostly self explanatory: -</p> -<ul> -<li> pre-build -</li><li> post-build -</li><li> build-fail -</li><li> pre-test -</li><li> test-fail -</li><li> pre-install -</li><li> post-install -</li><li> pre-remove -</li><li> post-remove -</li><li> pre-fetch -</li><li> post-fetch -</li><li> post-package -</li></ul> - -<p>In order to use hooks, you will need to set the <code>CPT_HOOK</code> variable pointing -to your hook file. Your hook file <strong>MUST</strong> be a POSIX shell script as its -contents are sourced by the package manager. -</p> -<p>The hook is given 3 variables when it is executed. Those are: -</p><dl compact="compact"> -<dt><code>$TYPE</code></dt> -<dd><p>The type of the hook, (pre-build, post-build, etc.) -</p></dd> -<dt><code>$PKG</code></dt> -<dd><p>The package that <code>cpt</code> is currently working on. Can be null. -</p></dd> -<dt><code>$DEST</code></dt> -<dd><p>The destination of the operation. Can be null. -</p></dd> -</dl> - - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Editing-the-build-file-during-pre_002dbuild.html" accesskey="1">Editing the <samp>build</samp> file during pre-build</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/src/docs/Hosts-file.html b/src/docs/Hosts-file.html new file mode 100644 index 0000000..ed26d62 --- /dev/null +++ b/src/docs/Hosts-file.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Hosts file (Carbs Linux User Manual)</title> + +<meta name="description" content="Hosts file (Carbs Linux User Manual)"> +<meta name="keywords" content="Hosts file (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="System-Configuration.html" rel="up" title="System Configuration"> +<link href="Kernel.html" rel="next" title="Kernel"> +<link href="Configuring-hostname.html" rel="prev" title="Configuring hostname"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Hosts-file"></span><div class="header"> +<p> +Previous: <a href="Configuring-hostname.html" accesskey="p" rel="prev">Configuring hostname</a>, Up: <a href="System-Configuration.html" accesskey="u" rel="up">System Configuration</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Hosts-file-1"></span><h4 class="subsection">1.3.2 Hosts file</h4> + +<p>You can edit your /etc/hosts file, which is the static lookup table for host +names. By default, there are two entries for localhost which are OKAY. You can +replace the ’localhost’ part of these entries to your hostname. +</p> +<div class="example"> +<pre class="example">127.0.0.1 localhost.localdomain localhost +::1 localhost.localdomain localhost ip6-localhost +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Init-Hooks.html b/src/docs/Init-Hooks.html index a5a767d..52e2e84 100644 --- a/src/docs/Init-Hooks.html +++ b/src/docs/Init-Hooks.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -20,9 +21,9 @@ Documentation License." --> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Init-System.html" rel="up" title="Init System"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> <link href="Changing-Init-Program.html" rel="next" title="Changing Init Program"> -<link href="Configuring-Init.html" rel="prev" title="Configuring Init"> +<link href="_002fetc_002finit_002frcconf-file.html" rel="prev" title="/etc/init/rcconf file"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,28 +49,31 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Init-Hooks"></span><div class="header"> <p> -Next: <a href="Changing-Init-Program.html" accesskey="n" rel="next">Changing Init Program</a>, Previous: <a href="Configuring-Init.html" accesskey="p" rel="prev">Configuring Init</a>, Up: <a href="Init-System.html" accesskey="u" rel="up">Init System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="_002fetc_002finit_002frcconf-file.html" accesskey="p" rel="prev">‘<samp>/etc/init/rcconf</samp>’ file</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Init-Hooks-1"></span><h3 class="section">3.2 Init Hooks</h3> +<span id="Init-Hooks-1"></span><h4 class="subsection">2.1.3 Init Hooks</h4> <p>Init hooks are for custom personal commands that the user may want to add to alter their boot. These can be used to load kernel modules, modify interfaces, -and lot more. Those hooks are added to the <samp>/etc/init</samp> directory with the +and lot more. Those hooks are added to the ‘<samp>/etc/init</samp>’ directory with the hook name as the suffix. For example, a boot script will be placed as -<samp>/etc/init/my-hook.boot</samp>. Currently, there are 4 hooks that the user can use. +‘<samp>/etc/init/my-hook.boot</samp>’. Currently, there are 4 hooks that the user can use. </p> <dl compact="compact"> -<dt><samp>early-boot</samp></dt> +<dt>early-boot</dt> <dd><p>Run after pseudo-filesystems are mounted. </p></dd> -<dt><samp>boot</samp></dt> +<dt>boot</dt> <dd><p>Run before the boot stage is completed. </p></dd> -<dt><samp>pre.shutdown</samp></dt> +<dt>pre.shutdown</dt> <dd><p>Run first when shutting down. </p></dd> -<dt><samp>post.shutdown</samp></dt> +<dt>umount</dt> +<dd><p>Run just before filesystems are unmounted. +</p></dd> +<dt>post.shutdown</dt> <dd><p>Run just before the system is halted. </p></dd> </dl> @@ -77,7 +81,5 @@ hook name as the suffix. For example, a boot script will be placed as - - </body> </html> diff --git a/src/docs/Init-System.html b/src/docs/Init-System.html index fac32cd..3d23ab0 100644 --- a/src/docs/Init-System.html +++ b/src/docs/Init-System.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> <link href="Configuring-Init.html" rel="next" title="Configuring Init"> -<link href="Setting-up-an-rsync-repository-for-distribution.html" rel="prev" title="Setting up an rsync repository for distribution"> +<link href="KISS-repositories.html" rel="prev" title="KISS repositories"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,29 +49,25 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Init-System"></span><div class="header"> <p> -Next: <a href="Contribution-Guidelines.html" accesskey="n" rel="next">Contribution Guidelines</a>, Previous: <a href="Package-Manager.html" accesskey="p" rel="prev">Package Manager</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Contribution-Guidelines.html" accesskey="n" rel="next">Contribution Guidelines</a>, Previous: <a href="Installation.html" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Init-System-1"></span><h2 class="chapter">3 Init System</h2> +<span id="Init-System-1"></span><h2 class="chapter">2 Init System</h2> -<p>Carbs Linux init scripts are run by the init daemon (<code>busybox</code> by default) -on boot and shutdown processes. It also provides its own halting program named +<p>Carbs Linux init scripts are run by the init daemon (‘<samp>busybox</samp>’ by default) on +boot and shutdown processes. It also provides its own halting program named shalt. This provides a portable method that doesn’t rely on non-POSIX external programs. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="Configuring-Init.html" accesskey="1">Configuring Init</a></td><td> </td><td align="left" valign="top">Ways to configure the init system </td></tr> -<tr><td align="left" valign="top">• <a href="Init-Hooks.html" accesskey="2">Init Hooks</a></td><td> </td><td align="left" valign="top">Adding your personal commands to the init system -</td></tr> -<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html" accesskey="3">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replacing the default busybox init with something new +<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html" accesskey="2">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replace the default busybox init with something new </td></tr> </table> - - </body> </html> diff --git a/docs/docs/cpt_002dsearch.html b/src/docs/Init-scripts.html index 289903f..bd5a32a 100644 --- a/docs/docs/cpt_002dsearch.html +++ b/src/docs/Init-scripts.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-search (Carbs Linux User Manual)</title> +<title>Init scripts (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-search (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-search (Carbs Linux User Manual)"> +<meta name="description" content="Init scripts (Carbs Linux User Manual)"> +<meta name="keywords" content="Init scripts (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dupdate.html" rel="next" title="cpt-update"> -<link href="cpt_002dremove.html" rel="prev" title="cpt-remove"> +<link href="Making-your-system-bootable.html" rel="up" title="Making your system bootable"> +<link href="Fstab.html" rel="next" title="Fstab"> +<link href="Bootloader.html" rel="prev" title="Bootloader"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,26 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dsearch"></span><div class="header"> +<span id="Init-scripts"></span><div class="header"> <p> -Next: <a href="cpt_002dupdate.html" accesskey="n" rel="next"><code>cpt-update</code></a>, Previous: <a href="cpt_002dremove.html" accesskey="p" rel="prev"><code>cpt-remove</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Fstab.html" accesskey="n" rel="next">Fstab</a>, Previous: <a href="Bootloader.html" accesskey="p" rel="prev">Bootloader</a>, Up: <a href="Making-your-system-bootable.html" accesskey="u" rel="up">Making your system bootable</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dsearch-1"></span><h4 class="subsection">2.1.9 <code>cpt-search</code></h4> +<span id="Init-scripts-1"></span><h4 class="subsection">1.5.2 Init scripts</h4> -<p><code>cpt-search</code> will remove given packages. +<p>Only thing left to do is installing the init-scripts, and now you are almost +ready to boot your system! </p> - - -<span id="Options-3"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-s --single</samp></dt> -<dd><p>Only show the first instance of a package. -</p></dd> -</dl> - - +<div class="example"> +<pre class="example">cpt b carbs-init && cpt i carbs-init +</pre></div> diff --git a/src/docs/Installation.html b/src/docs/Installation.html index 7116e8c..a85f8f4 100644 --- a/src/docs/Installation.html +++ b/src/docs/Installation.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -48,35 +49,32 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Installation"></span><div class="header"> <p> -Next: <a href="Package-Manager.html" accesskey="n" rel="next">Package Manager</a>, Previous: <a href="index.html" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previous: <a href="index.html" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> <span id="Installation-1"></span><h2 class="chapter">1 Installation</h2> -<p>These are the step-by-step instructions for installing Carbs Linux. -</p> -<p>The instructions can also be found plaintext on -<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a> +<p>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 +<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a>. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="1">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot </td></tr> <tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="2">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system </td></tr> -<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="3">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing for your personal use +<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="3">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing your system for personal use </td></tr> <tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="4">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="5">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing init and bootloader +<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="5">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing bootloader and boot scripts </td></tr> -<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html" accesskey="6">Post-installation</a></td><td> </td><td align="left" valign="top">Acquiring more packages and repositories +<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html" accesskey="6">Post-installation</a></td><td> </td><td align="left" valign="top">Post-installation tasks </td></tr> </table> - - </body> </html> diff --git a/src/docs/Installing-packages.html b/src/docs/Installing-packages.html new file mode 100644 index 0000000..2a2e342 --- /dev/null +++ b/src/docs/Installing-packages.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Installing packages (Carbs Linux User Manual)</title> + +<meta name="description" content="Installing packages (Carbs Linux User Manual)"> +<meta name="keywords" content="Installing packages (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Essential-Software.html" rel="next" title="Essential Software"> +<link href="Updating-packages.html" rel="prev" title="Updating packages"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Installing-packages"></span><div class="header"> +<p> +Next: <a href="Essential-Software.html" accesskey="n" rel="next">Essential Software</a>, Previous: <a href="Updating-packages.html" accesskey="p" rel="prev">Updating packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Installing-packages-1"></span><h4 class="subsection">1.2.3 Installing packages</h4> + +<p>Since you are operating on a really small base, you might need to build and +install new programs to extend the functionality of your system. In order to +build and install packages new packages in Carbs, you need to execute the +following. "Package" is not actually a package and is given as an example. +</p> +<div class="example"> +<pre class="example">cpt-build package +cpt-install package +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/cpt_002dfetch.html b/src/docs/KISS-repositories.html index 0b5c840..3824e9e 100644 --- a/src/docs/cpt_002dfetch.html +++ b/src/docs/KISS-repositories.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-fetch (Carbs Linux User Manual)</title> +<title>KISS repositories (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-fetch (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-fetch (Carbs Linux User Manual)"> +<meta name="description" content="KISS repositories (Carbs Linux User Manual)"> +<meta name="keywords" content="KISS repositories (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dinstall.html" rel="next" title="cpt-install"> -<link href="cpt_002ddownload.html" rel="prev" title="cpt-download"> +<link href="Post_002dinstallation.html" rel="up" title="Post-installation"> +<link href="Init-System.html" rel="next" title="Init System"> +<link href="Post_002dinstallation.html" rel="prev" title="Post-installation"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,19 +47,19 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dfetch"></span><div class="header"> +<span id="KISS-repositories"></span><div class="header"> <p> -Next: <a href="cpt_002dinstall.html" accesskey="n" rel="next"><code>cpt-install</code></a>, Previous: <a href="cpt_002ddownload.html" accesskey="p" rel="prev"><code>cpt-download</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Up: <a href="Post_002dinstallation.html" accesskey="u" rel="up">Post-installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dfetch-1"></span><h4 class="subsection">2.1.5 <code>cpt-fetch</code></h4> +<span id="KISS-repositories-1"></span><h4 class="subsection">1.6.1 KISS repositories</h4> -<p><code>cpt-fetch</code> will fetch remote repositories. +<p>While not 100% compatible with cpt, you can use kiss repositories in your +system the same way you are using the distribution repositories. Here is an +example for the KISS Linux Community repository. </p> - - </body> </html> diff --git a/src/docs/Kernel-Command-Line.html b/src/docs/Kernel-Command-Line.html new file mode 100644 index 0000000..a099dc8 --- /dev/null +++ b/src/docs/Kernel-Command-Line.html @@ -0,0 +1,83 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Kernel Command Line (Carbs Linux User Manual)</title> + +<meta name="description" content="Kernel Command Line (Carbs Linux User Manual)"> +<meta name="keywords" content="Kernel Command Line (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> +<link href="_002fetc_002finit_002frcconf-file.html" rel="next" title="/etc/init/rcconf file"> +<link href="Configuring-Init.html" rel="prev" title="Configuring Init"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Kernel-Command-Line"></span><div class="header"> +<p> +Next: <a href="_002fetc_002finit_002frcconf-file.html" accesskey="n" rel="next">‘<samp>/etc/init/rcconf</samp>’ file</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Kernel-Command-Line-1"></span><h4 class="subsection">2.1.1 Kernel Command Line</h4> + +<p>On GRUB, you can edit the kernel command line parameters, which will be parsed +as variables on the init system. Not all of the parameters will be acted upon, +but all of them will be set as variables on the init script. For example an +example command line, and how it is interpreted. +</p> +<div class="example"> +<pre class="example">BOOT_IMAGE=/boot/vmlinuz root=/dev/sda2 rw loglevel=3 quiet +</pre></div> + +<p>This command line will be parsed to set the following variables: +</p> +<div class="example"> +<pre class="example">BOOT_IMAGE=/boot/vmlinuz +root=/dev/sda2 +rw=1 +loglevel=3 +quiet=1 +</pre></div> + +<p>Some of these variables, such as ‘<samp>rw=/=ro</samp>’, ‘<samp>loglevel</samp>’, and ‘<samp>quiet</samp>’, will be +used by the init system to change the behaviour of the startup. +</p> + + + +</body> +</html> diff --git a/src/docs/Kernel-dependencies.html b/src/docs/Kernel-dependencies.html new file mode 100644 index 0000000..192479b --- /dev/null +++ b/src/docs/Kernel-dependencies.html @@ -0,0 +1,81 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Kernel dependencies (Carbs Linux User Manual)</title> + +<meta name="description" content="Kernel dependencies (Carbs Linux User Manual)"> +<meta name="keywords" content="Kernel dependencies (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Building-the-kernel.html" rel="next" title="Building the kernel"> +<link href="Obtaining-the-kernel-sources.html" rel="prev" title="Obtaining the kernel sources"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Kernel-dependencies"></span><div class="header"> +<p> +Next: <a href="Building-the-kernel.html" accesskey="n" rel="next">Building the kernel</a>, Previous: <a href="Obtaining-the-kernel-sources.html" accesskey="p" rel="prev">Obtaining the kernel sources</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Kernel-dependencies-1"></span><h4 class="subsection">1.4.2 Kernel dependencies</h4> + +<p>In order to compile the kernel you will need to install some dependencies. You +will need ‘<samp>libelf</samp>’ to compile the kernel. If you want to configure using the +menu interface you will also need ‘<samp>ncurses</samp>’. +</p> +<div class="example"> +<pre class="example"># The package manager asks to install if you are building more than one package, +# so no need to run 'cpt i ...' +cpt b libelf ncurses +</pre></div> + +<p>In the vanilla kernel sources, you need perl to compile the kernel, but it can +be easily patched out. You will need to apply the following patch. Patch was +written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and apply the patch in the kernel +source directory. +</p> +<div class="example"> +<pre class="example">wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch +patch -p1 < kernel-no-perl.patch +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Kernel.html b/src/docs/Kernel.html index 5f3eb9d..10f3945 100644 --- a/src/docs/Kernel.html +++ b/src/docs/Kernel.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Making-your-system-bootable.html" rel="next" title="Making your system bootable"> -<link href="System-Configuration.html" rel="prev" title="System Configuration"> +<link href="Obtaining-the-kernel-sources.html" rel="next" title="Obtaining the kernel sources"> +<link href="Hosts-file.html" rel="prev" title="Hosts file"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -54,74 +55,19 @@ Next: <a href="Making-your-system-bootable.html" accesskey="n" rel="next">Making <span id="Kernel-1"></span><h3 class="section">1.4 Kernel</h3> <p>Kernel isn’t managed under the main repositories, even though you could package -one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, -which you will need to reconfigure for your specific setup if you want to make -use of it. +one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, which you will +need to reconfigure for your specific setup if you want to make use of it. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Obtaining-the-kernel-sources.html" accesskey="1">Obtaining the kernel sources</a></td><td> </td><td align="left" valign="top">Downloading the Linux source code +</td></tr> +<tr><td align="left" valign="top">• <a href="Kernel-dependencies.html" accesskey="2">Kernel dependencies</a></td><td> </td><td align="left" valign="top">Requirements for building the kernel +</td></tr> +<tr><td align="left" valign="top">• <a href="Building-the-kernel.html" accesskey="3">Building the kernel</a></td><td> </td><td align="left" valign="top">Configure and compile the kernel +</td></tr> +</table> -<span id="Obtaining-the-kernel-sources"></span><h4 class="subsection">1.4.1 Obtaining the kernel sources</h4> - -<p>You can visit the https://kernel.org website to choose a kernel that you want -to install. Though only the latest stable and longterm (LTS) versions are -supported. -</p> -<div class="example"> -<pre class="example">Download the kernel and extract it -$ wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz -$ tar xf linux-5.7.6.tar.xz - -Change directory into the kernel sources -$ cd linux-5.7.6 -</pre></div> - - - -<span id="Installing-dependencies"></span><h4 class="subsection">1.4.2 Installing dependencies</h4> - -<p>In order to compile the kernel you will need to install some dependencies. You -will need <code>libelf</code> to compile the kernel. If you want to configure using the menu -interface you will also need <code>ncurses</code>. -</p> -<div class="example"> -<pre class="example">The package manager asks to install if you are building more than one package, -so no need to run 'cpt i ...' -$ cpt b libelf ncurses -</pre></div> - -<p>In the vanilla kernel sources, you need perl to compile the kernel, but it can -be easily patched out. You will need to apply the following patch. Patch was -written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and -apply the patch in the kernel source directory. -</p> -<div class="example"> -<pre class="example">$ wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch -$ patch -p1 < kernel-no-perl.patch -</pre></div> - - - -<span id="Compiling-the-kernel"></span><h4 class="subsection">1.4.3 Compiling the kernel</h4> - -<p>Next step is configuring and building the kernel. You can check Gentoo’s <a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> -to learn more about the matter. Overall, Gentoo Wiki is a good place to learn -about configuration according to your hardware. The following will assume a -monolithic kernel. -</p> -<div class="example"> -<pre class="example">$ make menuconfig -$ make -$ install -Dm755 $(make -s image_name) /boot/vmlinuz-linux -</pre></div> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Making-your-system-bootable.html" accesskey="n" rel="next">Making your system bootable</a>, Previous: <a href="System-Configuration.html" accesskey="p" rel="prev">System Configuration</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/src/docs/Making-your-system-bootable.html b/src/docs/Making-your-system-bootable.html index 58714a3..2e3a759 100644 --- a/src/docs/Making-your-system-bootable.html +++ b/src/docs/Making-your-system-bootable.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Post_002dinstallation.html" rel="next" title="Post-installation"> -<link href="Kernel.html" rel="prev" title="Kernel"> +<link href="Bootloader.html" rel="next" title="Bootloader"> +<link href="Building-the-kernel.html" rel="prev" title="Building the kernel"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -57,61 +58,14 @@ Next: <a href="Post_002dinstallation.html" accesskey="n" rel="next">Post-install init-scripts and a bootloader. The init daemon is already provided by busybox, but you can optionally change it. </p> - - -<span id="Installing-a-bootloader"></span><h4 class="subsection">1.5.1 Installing a bootloader</h4> - -<p>In the main repository, there is efibootmgr and grub to serve as bootloaders. -efibootmgr can be used as a standalone bootloader, or can be used to install -grub in a UEFI environment. efibootmgr is needed unless you are using a device -without UEFI support (or you really want to use BIOS for a reason). -</p> -<p>GRUB BIOS installation -</p> -<div class="example"> -<pre class="example">$ cpt b grub && cpt i grub -$ grub-install --target=i386-pc /dev/sdX -$ grub-mkconfig -o /boot/grub/grub.cfg -</pre></div> - -<p>GRUB UEFI installation -</p> -<div class="example"> -<pre class="example">$ cpt b efibootmgr && cpt i efibootmgr -$ cpt b grub && cpt i grub - -$ grub-install --target=x86_64-efi \ - --efi-directory=esp \ - --bootloader-id=CarbsLinux - -$ grub-mkconfig -o /boot/grub/grub.cfg -</pre></div> - - - -<span id="Installing-init-scripts"></span><h4 class="subsection">1.5.2 Installing init scripts</h4> - -<p>Only thing left to do is installing the init-scripts, and now you are almost -ready to boot your system! -</p> -<div class="example"> -<pre class="example">$ cpt b carbs-init && cpt i carbs-init -</pre></div> - - - -<span id="Generating-fstab"></span><h4 class="subsection">1.5.3 Generating fstab</h4> - -<p>You can now manually edit your fstab entry, or you can use the genfstab tool. -If you want to use the tool, exit the chroot and run the following: -</p> -<div class="example"> -<pre class="example">$ wget https://github.com/cemkeylan/genfstab/raw/master/genfstab -$ chmod +x genfstab -$ ./genfstab -U /mnt >> /mnt/etc/fstab -</pre></div> - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Bootloader.html" accesskey="1">Bootloader</a></td><td> </td><td align="left" valign="top">Install a bootloader for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-scripts.html" accesskey="2">Init scripts</a></td><td> </td><td align="left" valign="top">Install init scripts for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Fstab.html" accesskey="3">Fstab</a></td><td> </td><td align="left" valign="top">Generating fstab +</td></tr> +</table> diff --git a/src/docs/Obtain-the-chroot-helper.html b/src/docs/Obtain-the-chroot-helper.html new file mode 100644 index 0000000..e5fc1d3 --- /dev/null +++ b/src/docs/Obtain-the-chroot-helper.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Obtain the chroot helper (Carbs Linux User Manual)</title> + +<meta name="description" content="Obtain the chroot helper (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtain the chroot helper (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Chroot.html" rel="next" title="Chroot"> +<link href="Extracting-the-tarball.html" rel="prev" title="Extracting the tarball"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Obtain-the-chroot-helper"></span><div class="header"> +<p> +Previous: <a href="Extracting-the-tarball.html" accesskey="p" rel="prev">Extracting the tarball</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Obtain-the-chroot-helper-1"></span><h4 class="subsection">1.1.4 Obtain the chroot helper</h4> + +<p>You can obtain the ‘<samp>cpt-chroot</samp>’ script in order to do a simple chroot into your +new root filesystem. +</p> +<div class="example"> +<pre class="example">wget https://dl.carbslinux.org/distfiles/cpt-chroot +chmod a+x cpt-chroot +</pre></div> + + + + +</body> +</html> diff --git a/docs/docs/cpt_002dremove.html b/src/docs/Obtaining-the-documentation.html index 93a7ff8..03739b5 100644 --- a/docs/docs/cpt_002dremove.html +++ b/src/docs/Obtaining-the-documentation.html @@ -7,22 +7,23 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-remove (Carbs Linux User Manual)</title> +<title>Obtaining the documentation (Carbs Linux User Manual)</title> -<meta name="description" content="cpt-remove (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-remove (Carbs Linux User Manual)"> +<meta name="description" content="Obtaining the documentation (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtaining the documentation (Carbs Linux User Manual)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dsearch.html" rel="next" title="cpt-search"> -<link href="cpt_002dlist.html" rel="prev" title="cpt-list"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="System-Configuration.html" rel="next" title="System Configuration"> +<link href="Essential-Software.html" rel="prev" title="Essential Software"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -46,29 +47,28 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<span id="cpt_002dremove"></span><div class="header"> +<span id="Obtaining-the-documentation"></span><div class="header"> <p> -Next: <a href="cpt_002dsearch.html" accesskey="n" rel="next"><code>cpt-search</code></a>, Previous: <a href="cpt_002dlist.html" accesskey="p" rel="prev"><code>cpt-list</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Previous: <a href="Essential-Software.html" accesskey="p" rel="prev">Essential Software</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="cpt_002dremove-1"></span><h4 class="subsection">2.1.8 <code>cpt-remove</code></h4> +<span id="Obtaining-the-documentation-1"></span><h4 class="subsection">1.2.5 Obtaining the documentation</h4> -<p><code>cpt-remove</code> will remove given packages. +<p>All the documentation for Carbs Linux can be found on a single info manual to be +viewed offline. You can obtain texinfo or the info (standalone) package in order +to view the documentation. </p> +<div class="example"> +<pre class="example"># Install the documentation. +cpt b carbs-docs && cpt i carbs-docs +# Install either texinfo or the info package. We will be installing standalone info +# as it doesn't need perl. +cpt b info && cpt i info -<span id="Options-2"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-f --force</samp></dt> -<dd><p>Force removal. See <a href="Environment-Variables.html#cptforce"><code>CPT_FORCE</code></a>. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Set an alternative root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - +# You can then run info and navigate through the documentation. +info carbslinux +</pre></div> diff --git a/src/docs/Obtaining-the-kernel-sources.html b/src/docs/Obtaining-the-kernel-sources.html new file mode 100644 index 0000000..5acdb26 --- /dev/null +++ b/src/docs/Obtaining-the-kernel-sources.html @@ -0,0 +1,74 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Obtaining the kernel sources (Carbs Linux User Manual)</title> + +<meta name="description" content="Obtaining the kernel sources (Carbs Linux User Manual)"> +<meta name="keywords" content="Obtaining the kernel sources (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Kernel.html" rel="up" title="Kernel"> +<link href="Kernel-dependencies.html" rel="next" title="Kernel dependencies"> +<link href="Kernel.html" rel="prev" title="Kernel"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Obtaining-the-kernel-sources"></span><div class="header"> +<p> +Next: <a href="Kernel-dependencies.html" accesskey="n" rel="next">Kernel dependencies</a>, Up: <a href="Kernel.html" accesskey="u" rel="up">Kernel</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Obtaining-the-kernel-sources-1"></span><h4 class="subsection">1.4.1 Obtaining the kernel sources</h4> + +<p>You can visit the <a href="https://kernel.org">https://kernel.org</a> website to choose a kernel that you want +to install. Though only the latest stable and longterm (LTS) versions are +supported. +</p> +<div class="example"> +<pre class="example"># Download the kernel and extract it +wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz +tar xf linux-5.9.1.tar.xz + +# Change directory into the kernel sources +cd linux-5.9.1 +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Package-Manager.html b/src/docs/Package-Manager.html deleted file mode 100644 index 14ca738..0000000 --- a/src/docs/Package-Manager.html +++ /dev/null @@ -1,81 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Package Manager (Carbs Linux User Manual)</title> - -<meta name="description" content="Package Manager (Carbs Linux User Manual)"> -<meta name="keywords" content="Package Manager (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="index.html" rel="up" title="Top"> -<link href="Usage.html" rel="next" title="Usage"> -<link href="Post_002dinstallation.html" rel="prev" title="Post-installation"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Package-Manager"></span><div class="header"> -<p> -Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previous: <a href="Installation.html" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Package-Manager-1"></span><h2 class="chapter">2 Package Manager</h2> - -<p>Carbs Linux uses its own package managing toolchain named <code>cpt</code>. It is a -fork of the <a href="https://github.com/kisslinux/kiss">kiss</a> package manager. -Unlike <code>kiss</code>, however, its main goal is being easily extendable. -Instead of being a single file package manager, it revolves around the shell -library <code>cpt-lib</code>, and many tools that wrap around it. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Usage.html" accesskey="1">Usage</a></td><td> </td><td align="left" valign="top">Using Carbs Packaging Tools -</td></tr> -<tr><td align="left" valign="top">• <a href="Environment-Variables.html" accesskey="2">Environment Variables</a></td><td> </td><td align="left" valign="top">Values that affect the operation of CPT -</td></tr> -<tr><td align="left" valign="top">• <a href="Hooks.html" accesskey="3">Hooks</a></td><td> </td><td align="left" valign="top">Using hooks to customize the package manager operations -</td></tr> -<tr><td align="left" valign="top">• <a href="Packaging-System.html" accesskey="4">Packaging System</a></td><td> </td><td align="left" valign="top">More detail on creating packages -</td></tr> -<tr><td align="left" valign="top">• <a href="Rsync-Repositories.html" accesskey="5">Rsync Repositories</a></td><td> </td><td align="left" valign="top">Information on using or creating rsync repositories -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/src/docs/Packaging-System.html b/src/docs/Packaging-System.html deleted file mode 100644 index 7268068..0000000 --- a/src/docs/Packaging-System.html +++ /dev/null @@ -1,226 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Packaging System (Carbs Linux User Manual)</title> - -<meta name="description" content="Packaging System (Carbs Linux User Manual)"> -<meta name="keywords" content="Packaging System (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Rsync-Repositories.html" rel="next" title="Rsync Repositories"> -<link href="Editing-the-build-file-during-pre_002dbuild.html" rel="prev" title="Editing the build file during pre-build"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Packaging-System"></span><div class="header"> -<p> -Next: <a href="Rsync-Repositories.html" accesskey="n" rel="next">Rsync Repositories</a>, Previous: <a href="Hooks.html" accesskey="p" rel="prev">Hooks</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Packaging-System-1"></span><h3 class="section">2.4 Packaging System</h3> - -<p>A package is formed of several files, these are: -</p><ul> -<li> <samp>build</samp> -</li><li> <samp>sources</samp> -</li><li> <samp>checksums</samp> -</li><li> <samp>version</samp> -</li><li> <samp>depends</samp> -</li><li> <samp>post-install</samp> -</li><li> <samp>message</samp> -</li><li> <samp>test</samp> -</li></ul> - -<p>Any other file can be added to the package directory at the discretion of the -package maintainer. Everything in the package directory will also be added to the -package database that is located on ’/var/db/cpt/installed’. These can be -patches, configuration files, etc. -</p> - - -<span id="build"></span><h4 class="subsection">2.4.1 <samp>build</samp></h4> - -<p>Typically <samp>build</samp> files are shell scripts that run commands to prepare the source -code to be installed on the target system. Even though we will be assuming that -the <samp>build</samp> file is a POSIX shell script (for portability’s sake), <samp>build</samp> -files can be any executable program from binary programs to <code>perl</code> scripts. -</p> -<p>The contents of a build script do not need to follow a certain rule for the -package manager, except for the fact that the user needs the permission to -execute the file. -</p> -<p>An important advice is to append an ’-e’ to the shebang (#!/bin/sh -e) so that -the build script exits on compilation error. -</p> -<p>Build is run with three arguments (<code>$#</code>) -</p> -<ol> -<li> Location of the package directory (DESTDIR) -</li><li> Package version -</li><li> System architecture -</li></ol> - - - -<span id="sources"></span><h4 class="subsection">2.4.2 <samp>sources</samp></h4> - -<p><samp>sources</samp> file is a list of files and sources that will be put to the build -directory during the build process. Those can be remote sources (such as tarballs), -git repositories, and files that reside on the package directory. -</p> -<p>The syntax is pretty simple for the <samp>soures</samp> file; <tt>src dest</tt>. The -<code>dest</code> parameter is optional. It is the directory that the source will be -placed in. Here is the <samp>sources</samp> file for the <code>gst-plugins</code> package: -</p> -<div class="example"> -<pre class="example">https://gstreamer.freedesktop.org/src/gst-plugins-good/gst-plugins-good-1.16.2.tar.xz good -https://gstreamer.freedesktop.org/src/gst-plugins-bad/gst-plugins-bad-1.16.2.tar.xz bad -https://gstreamer.freedesktop.org/src/gst-plugins-ugly/gst-plugins-ugly-1.16.2.tar.xz ugly -https://gstreamer.freedesktop.org/src/gst-libav/gst-libav-1.16.2.tar.xz libav -</pre></div> - -<p>This file is read from the package manager as space seperated. Files that begin -with a ’#’ comment are ignored. The first value points to the location of the -source. -</p> -<p>If it starts with a protcol url, (such as ftp:// http:// https://) it will be -downloaded with <code>curl</code>. -</p> -<p>If the source is a git repository, it shall be prefixed with a <tt>git+</tt> git(1) will -be used to do a shallow clone of the repository. If the commit is suffixed by a -history pointer, git will checkout the relevant revision. So, -</p> -<dl compact="compact"> -<dt>‘<code>git+git://example.com/pub/repo#v1.2.3</code>’</dt> -<dd><p>will checkout the tag named ’v1.2.3’ -</p></dd> -<dt>‘<code>git+git://example.com/pub/repo#development</code>’</dt> -<dd><p>will checkout the branch named ’development’ -</p></dd> -<dt>‘<code>git+git://example.com/pub/repo#1a314s87</code>’</dt> -<dd><p>will checkout the commit named ’1a314s87’ -</p></dd> -</dl> - -<p>Other files are assumed to be residing in the package directory. They should be -added with their paths relative to the package directory. -</p> - - -<span id="checksums"></span><h4 class="subsection">2.4.3 <samp>checksums</samp></h4> - -<p>checksums file is generated by the <samp>cpt c pkg command</samp>. It is generated -according to the order of the sources file. That’s why you shouldn’t be editing -it manually. The checksums file is created with the digests of the files using -the sha256 algorithm. -</p> - - -<span id="version"></span><h4 class="subsection">2.4.4 <samp>version</samp></h4> - -<p>The version file includes the version of the software and the release number of -of the package on a space seperated format. The contents of the file should look -like below. -</p> -<div class="example"> -<pre class="example">1.3.2 1 -</pre></div> - -<p>The version should always match to the number of the upstream release. For -drastic changes that require a rebuild Those can be, -</p> -<ul> -<li> update of libraries that forces the package to be relinked -</li><li> change in the build scripts that affect the output of the package -</li></ul> - -<p>When a version bump occurs, the release should be reset to 1. -</p> - - -<span id="depends"></span><h4 class="subsection">2.4.5 <samp>depends</samp></h4> - -<p>This is a list of dependencies that must be installed before a package build. You -can append “make” after a dependency to mark a package is only required during -the build process of a package. Packages marked as a make dependency can be -removed after the build. There are also “test” dependencies. These dependencies -are only installed if either the <code>CPT_TEST</code> is set to 1, or the build is run -with the <samp>-t</samp> or <samp>--test</samp> options. So, a package package could have -the following <samp>depends</samp> file: -</p> -<div class="example"> -<pre class="example">linux-headers make -python test -zlib -</pre></div> - - - -<span id="post_002dinstall"></span><h4 class="subsection">2.4.6 <samp>post-install</samp></h4> - -<p><samp>post-install</samp> files have the same requirements as the build script. They -will be run after the package is installed as root (or as the user if the user -has write permissions on <code>CPT_ROOT</code>). -</p> - - -<span id="message"></span><h4 class="subsection">2.4.7 <samp>message</samp></h4> - -<p>This plaintext file will be outputted with <code>cat</code> after every package is -installed. -</p> - - -<span id="test"></span><h4 class="subsection">2.4.8 <samp>test</samp></h4> - -<p>Test files are mainly for the repository maintainer to test the packages, and -will only run if the user has the <code>CPT_TEST</code> variable set, or the build is -run with the <samp>-t</samp> or <samp>--test</samp> options. This script is run on the -build directory. It is run right after the build script is finished. -</p> - - -<hr> -<div class="header"> -<p> -Next: <a href="Rsync-Repositories.html" accesskey="n" rel="next">Rsync Repositories</a>, Previous: <a href="Hooks.html" accesskey="p" rel="prev">Hooks</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/src/docs/Post_002dinstallation.html b/src/docs/Post_002dinstallation.html index 6afbb2d..da1dc05 100644 --- a/src/docs/Post_002dinstallation.html +++ b/src/docs/Post_002dinstallation.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Package-Manager.html" rel="next" title="Package Manager"> -<link href="Making-your-system-bootable.html" rel="prev" title="Making your system bootable"> +<link href="KISS-repositories.html" rel="next" title="KISS repositories"> +<link href="Fstab.html" rel="prev" title="Fstab"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -55,29 +56,12 @@ Previous: <a href="Making-your-system-bootable.html" accesskey="p" rel="prev">Ma <p>The base installation is now complete, you can now fine tune your system according to your needs. Rest of these instructions are completely optional. +You can check the rest of the documentation to learn more about the system. </p> - - -<span id="Acquiring-kiss-repositories"></span><h4 class="subsection">1.6.1 Acquiring kiss repositories</h4> - -<p>While not 100% compatible with cpt, you can use kiss repositories in your -system the same way you are using the distribution repositories. Here is an -example for the KISS Linux Community repository. -</p> -<div class="example"> -<pre class="example">$ git clone https://github.com/kisslinux/community $HOME/repos/kiss-community -$ export CPT_PATH=$CPT_PATH:$HOME/repos/kiss-community/community -</pre></div> - -<p>NOTE: There are lots of packages on the KISS community repository that are also -on Carbs Linux main repository. I would advise giving lower priority to the KISS -community repository as it may affect other packages that you might install. -</p> - - - - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="KISS-repositories.html" accesskey="1">KISS repositories</a></td><td> </td><td align="left" valign="top">Acquire kiss repositories +</td></tr> +</table> diff --git a/src/docs/Preparing-Environment.html b/src/docs/Preparing-Environment.html index a5c43f9..89fc029 100644 --- a/src/docs/Preparing-Environment.html +++ b/src/docs/Preparing-Environment.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Chroot.html" rel="next" title="Chroot"> +<link href="Download.html" rel="next" title="Download"> <link href="Installation.html" rel="prev" title="Installation"> <style type="text/css"> <!-- @@ -52,6 +53,7 @@ Next: <a href="Chroot.html" accesskey="n" rel="next">Chroot</a>, Up: <a href="In </div> <hr> <span id="Preparing-Environment-1"></span><h3 class="section">1.1 Preparing Environment</h3> + <p>To install Carbs Linux, you will need a Live Linux ISO. For that purpose, you can obtain a Gentoo or Void Linux live image. You can follow their instructions to boot and setup your network. @@ -68,81 +70,18 @@ to boot and setup your network. <p>Rest of these instructions will assume that you have set all of these up, and will continue on that point. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Download.html" accesskey="1">Download</a></td><td> </td><td align="left" valign="top">Download the root filesystem tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Signature-verification.html" accesskey="2">Signature verification</a></td><td> </td><td align="left" valign="top">Verify the signature of the rootfs tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Extracting-the-tarball.html" accesskey="3">Extracting the tarball</a></td><td> </td><td align="left" valign="top">Extracting the root filesystem to the desired location +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtain-the-chroot-helper.html" accesskey="4">Obtain the chroot helper</a></td><td> </td><td align="left" valign="top">Download the script to easily chroot into the new filesystem +</td></tr> +</table> -<span id="Download"></span><h4 class="subsection">1.1.1 Download</h4> - -<p>First, we need to download the rootfs tarball. You can do the following in order -to obtain the rootfs. If you are using an i686 machine, replace the -<code>x86_64</code> with <code>i686</code>. We are setting this in a URL variable so that we -don’t have to write it every time. -</p> -<div class="example"> -<pre class="example">$ URL=https://dl.carbslinux.org/releases/x86_64 -$ wget $URL/carbs-rootfs.tar.xz -</pre></div> - -<p>We can then check the integrity of the tarball and do a signature verification. -Even thought these are optional, they are highly recommended. -</p> - - -<span id="Check-the-integrity-of-the-tarball-_0028Recommended_0029"></span><h4 class="subsection">1.1.2 Check the integrity of the tarball (Recommended)</h4> - -<p>All of the releases are saved in a single file named <samp>sha256sums.txt</samp>, but -the latest release is saved on <samp>carbs-rootfs.tar.xz.sha256</samp>. You can -acquire and verify the tarball. -</p> -<div class="example"> -<pre class="example">$ wget $URL/carbs-rootfs.tar.xz.sha256 -$ sha256sum -c carbs-rootfs.tar.xz.sha256 -</pre></div> - - - -<span id="Verify-the-signature"></span><h4 class="subsection">1.1.3 Verify the signature</h4> - -<p>It is highly recommended to verify the signature of the tarball. You will need -GPG for this. -</p> -<div class="example"> -<pre class="example">$ wget $URL/carbs-rootfs.tar.xz.sig -$ gpg --recv-keys FF484BDFEFCEF8FF -$ gpg --verify carbs-rootfs.tar.xz.sig -</pre></div> - - - -<span id="Extracting-the-tarball"></span><h4 class="subsection">1.1.4 Extracting the tarball</h4> - -<p>You will need to extract the tarball to your desired location. For partitioning, -you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. -This will assume that you will be mounting your root partition to <samp>/mnt</samp>. -</p> -<div class="example"> -<pre class="example">$ mount /dev/sdx1 /mnt -$ tar xf carbs-rootfs.tar.xz -C /mnt -</pre></div> - - - -<span id="Obtain-the-chroot-helper"></span><h4 class="subsection">1.1.5 Obtain the chroot helper</h4> - -<p>You can obtain the <code>cpt-chroot</code> script in order to do a simple chroot into -your new root filesystem. -</p> -<div class="example"> -<pre class="example">$ wget https://dl.carbslinux.org/distfiles/cpt-chroot -$ chmod a+x cpt-chroot -</pre></div> - - -<hr> -<div class="header"> -<p> -Next: <a href="Chroot.html" accesskey="n" rel="next">Chroot</a>, Up: <a href="Installation.html" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - </body> diff --git a/src/docs/Rebooting-after-changing-init.html b/src/docs/Rebooting-after-changing-init.html new file mode 100644 index 0000000..85d02cf --- /dev/null +++ b/src/docs/Rebooting-after-changing-init.html @@ -0,0 +1,73 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Rebooting after changing init (Carbs Linux User Manual)</title> + +<meta name="description" content="Rebooting after changing init (Carbs Linux User Manual)"> +<meta name="keywords" content="Rebooting after changing init (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Changing-Init-Program.html" rel="up" title="Changing Init Program"> +<link href="Contribution-Guidelines.html" rel="next" title="Contribution Guidelines"> +<link href="Changing-Init-Program.html" rel="prev" title="Changing Init Program"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Rebooting-after-changing-init"></span><div class="header"> +<p> +Up: <a href="Changing-Init-Program.html" accesskey="u" rel="up">Changing Init Program</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Rebooting-after-changing-init-1"></span><h4 class="subsection">2.2.1 Rebooting after changing init</h4> + +<p>After switching init systems, your running init system may not accept the +new poweroff commands. You will need to reboot/poweroff using the running init’s +utilities for the new utilities to work. These commands are for the init system +currently running on your system and not the one you are switching to. +</p> +<table> +<thead><tr><th>Program</th><th>Command</th></tr></thead> +<tr><td>busybox</td><td>‘<samp>busybox reboot</samp>’</td></tr> +<tr><td>runit</td><td>‘<samp>runit-init 6</samp>’</td></tr> +<tr><td>shinit/sinit</td><td>‘<samp>kill -s INT 1</samp>’</td></tr> +</table> + + + + +</body> +</html> diff --git a/src/docs/Repository-Conventions.html b/src/docs/Repository-Conventions.html index e333ff6..598cc7a 100644 --- a/src/docs/Repository-Conventions.html +++ b/src/docs/Repository-Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Conventions.html" rel="up" title="Conventions"> -<link href="Sending-Git-mails.html" rel="next" title="Sending Git mails"> +<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free Documentation License"> <link href="Shell-Conventions.html" rel="prev" title="Shell Conventions"> <style type="text/css"> <!-- @@ -51,52 +52,49 @@ ul.no-bullet {list-style: none} Previous: <a href="Shell-Conventions.html" accesskey="p" rel="prev">Shell Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Repository-Conventions-_002d_002d-20"></span><h4 class="subsection">4.1.3 Repository Conventions – 20</h4> +<span id="Repository-Conventions-1"></span><h4 class="subsection">3.1.2 Repository Conventions</h4> <p>Repository conventions are important in order to ensure every package resemble themselves. Here are the things to keep in mind: </p> <dl compact="compact"> -<dt><strong>[<span id="g_t2010"></span>2010]</strong></dt> -<dd><p>Prefer tarballs over git packages unless there is a sensible reason. -Here are some: -</p> -<ul> +<dt>[<span id="g_t2010"></span>2010]</dt> +<dd><p>Prefer tarballs over git packages unless there is a +sensible reason. Here are some: +</p><ul> <li> Every patch is a new release. (See <a href="https://github.com/vim/vim">vim</a>) -</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">https://git.suckless.org/sbase</a>) +</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">sbase</a>) </li><li> Following a development branch. -</li><li> There has been a long time since the latest release, but upstream is far ahead. +</li><li> There has been a long time since the latest release, but upstream is far +ahead. </li></ul> - </dd> -<dt><strong>[<span id="g_t2020"></span>2020]</strong></dt> -<dd><p>Prefer sources without a dependency to <code>automake</code>. There are usually -distribution tarballs that are <code>autoconf</code>’ed. Don’t submit tarballs -with an automake dependency unless you are <strong>sure</strong> there is no -alternative. +<dt>[<span id="g_t2020"></span>2020]</dt> +<dd><p>Prefer sources without a dependency to ‘<samp>automake</samp>’. There +are usually distribution tarballs that are ‘<samp>autoconf</samp>’’ed. Don’t submit tarballs +with an automake dependency unless you are ‘<samp>sure</samp>’ there is no alternative. </p></dd> -<dt><strong>[<span id="g_t2030"></span>2030]</strong></dt> +<dt>[<span id="g_t2030"></span>2030]</dt> <dd><p>Avoid these packages: </p><dl compact="compact"> -<dt><code>dbus</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-dbus</samp> +<dt>dbus</dt> +<dd><p>Usually can be disabled by <code>--disable-dbus</code>. </p></dd> -<dt><code>gettext</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-nls</samp> +<dt>gettext</dt> +<dd><p>Usually can be disabled by <code>--disable-nls</code>. </p></dd> </dl> </dd> -<dt><strong>[<span id="g_t2040"></span>2040]</strong></dt> +<dt>[<span id="g_t2040"></span>2040]</dt> <dd><ul> -<li> Always install a package to the <samp>/usr</samp> prefix. -</li><li> All binaries should go to <samp>/usr/bin</samp>, not <samp>/usr/sbin</samp> or any other -directory. -</li><li> All libraries should go to <samp>/usr/lib</samp>. +<li> Always install a package to the ‘<samp>/usr</samp>’ prefix. +</li><li> All binaries should go to ‘<samp>/usr/bin</samp>’, not ‘<samp>/usr/sbin</samp>’ or any other directory. +</li><li> All libraries should go to ‘<samp>/usr/lib</samp>’. </li></ul> </dd> -<dt><strong>[<span id="g_t2050"></span>2050]</strong></dt> -<dd><p>All build files on the repository should be a POSIX shell script, and must start -with <code>#!/bin/sh -e</code>. +<dt>[<span id="g_t2050"></span>2050]</dt> +<dd><p>All build files on the repository should be a POSIX +shell script, and must start with <code>#!/bin/sh -e</code>. </p></dd> </dl> @@ -104,10 +102,10 @@ with <code>#!/bin/sh -e</code>. ensure stylistic consistency. Note that the option configurations shouldn’t be taken literally, they are meant as examples. </p> +<ol> +<li> Make [<span id="g_t2210"></span>2210] -<p><strong>[<span id="g_t2210"></span>2210] Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -115,10 +113,9 @@ make make DESTDIR="$1" PREFIX=/usr install </pre></div> +</li><li> Configure/Make [<span id="g_t2211"></span>2211] -<p><strong>[<span id="g_t2211"></span>2211] Configure/Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -131,10 +128,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Autoconf/Automake [<span id="g_t2212"></span>2212] -<p><strong>[<span id="g_t2212"></span>2212] Autoconf/Automake</strong> -</p> <p>See <a href="#g_t2020">2020</a> </p> <div class="example"> @@ -151,10 +147,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Meson [<span id="g_t2220"></span>2220] -<p><strong>[<span id="g_t2220"></span>2220] Meson</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -170,10 +165,9 @@ ninja -C output ninja -C output install </pre></div> +</li><li> Cmake [<span id="g_t2230"></span>2230] -<p><strong>[<span id="g_t2230"></span>2230] Cmake</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -188,10 +182,9 @@ cmake --build build cmake --install build </pre></div> +</li><li> Go [<span id="g_t2240"></span>2240] -<p><strong>[<span id="g_t2240"></span>2240] Go</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -203,18 +196,16 @@ go build install -Dm755 program "$1/usr/bin/program" </pre></div> +</li><li> Python [<span id="g_t2241"></span>2241] -<p><strong>[<span id="g_t2241"></span>2241] Python</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e python setup.py build python setup.py install --prefix=/usr --root="$1" </pre></div> - - +</li></ol> <hr> <div class="header"> diff --git a/src/docs/Rsync-Repositories.html b/src/docs/Rsync-Repositories.html deleted file mode 100644 index fc67f9a..0000000 --- a/src/docs/Rsync-Repositories.html +++ /dev/null @@ -1,109 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Rsync Repositories (Carbs Linux User Manual)</title> - -<meta name="description" content="Rsync Repositories (Carbs Linux User Manual)"> -<meta name="keywords" content="Rsync Repositories (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="Setting-up-an-rsync-repository-for-distribution.html" rel="next" title="Setting up an rsync repository for distribution"> -<link href="Packaging-System.html" rel="prev" title="Packaging System"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Rsync-Repositories"></span><div class="header"> -<p> -Previous: <a href="Packaging-System.html" accesskey="p" rel="prev">Packaging System</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Rsync-Repositories-1"></span><h3 class="section">2.5 Rsync Repositories</h3> - -<p>Rsync repositories are simple to serve and simple to use. In the repository -directory, there needs to be a ’.rsync’ file that points to the remote of the -repository. This is used in order to fetch changes from the upstream. ’.rsync’ -file looks like this for the core repository: -</p> -<div class="example"> -<pre class="example">rsync://carbslinux.org/repo/core -</pre></div> - -<p>Rsync repositories have some few distinctions when it comes to fetching them. -They can be either synced individually or as a “root”. There are 2 important -files, those are <samp>.rsync</samp> and <samp>.rsync_root</samp>. Here is the Carbs Linux -rsync repository structure. -</p> -<div class="example"> -<pre class="example"> / - ----------------- - | | -.rsync core/ - ---------------- - | | - .rsync .rsync_root -</pre></div> - -<p>Unlike git repositories, they don’t have a defined “root” directory. This is -both an advantage and a disadvantage. This way, we can sync individual -repositories, but that also means we need extra files to define root directories -and repository locations. Here is the content for each of these files: -</p> -<div class="example"> -<pre class="example">/.rsync: rsync://carbslinux.org/repo -/core/.rsync: rsync://carbslinux.org/repo/core -/core/.rsync_root: .. -</pre></div> - -<p>The <samp>.rsync_root</samp> file on the core repository points to the upper directory. -If a <samp>.rsync</samp> file exists on the upper directory, this means that is the whole -repository and will sync the entire repository instead of each individual repository. -</p> -<p>If the upper directory doesn’t have this <samp>.rsync</samp> file, this means that this -is an individual repository, and the package manager will fetch accordingly. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Setting-up-an-rsync-repository-for-distribution.html" accesskey="1">Setting up an rsync repository for distribution</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - - - - -</body> -</html> diff --git a/src/docs/Sending-Git-mails.html b/src/docs/Sending-Git-mails.html deleted file mode 100644 index 5dcfbe6..0000000 --- a/src/docs/Sending-Git-mails.html +++ /dev/null @@ -1,106 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Sending Git mails (Carbs Linux User Manual)</title> - -<meta name="description" content="Sending Git mails (Carbs Linux User Manual)"> -<meta name="keywords" content="Sending Git mails (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> -<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free Documentation License"> -<link href="Repository-Conventions.html" rel="prev" title="Repository Conventions"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Sending-Git-mails"></span><div class="header"> -<p> -Previous: <a href="Conventions.html" accesskey="p" rel="prev">Conventions</a>, Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Sending-Git-mails-1"></span><h3 class="section">4.2 Sending Git mails</h3> - -<p>As mentioned, the preferred way of contribution is via patches. The easiest way -for sending git mails without <code>git send-email</code> is using <code>msmtp</code>. -You can install it from the repository by doing: -</p> -<div class="example"> -<pre class="example">$ cpt b msmtp && cpt i msmtp -</pre></div> - -<p>You can then edit <samp>~/.config/msmtp/config</samp> to add your email. Here is an -example configuration, you can use <code>pass</code>, <code>pash</code>, or any other -password manager that fits your needs: -</p> -<div class="example"> -<pre class="example">defaults -auth on -tls on -tls_trust_file /etc/ssl/certs/ca-certificates.crt -logfile ~/.config/msmtp/msmtp.log -account my-mail -host mail.example.com -port 587 -from me@example.com -user me@example.com -passwordeval "pass my-mail" -</pre></div> - -<p>In order to simply send your patch, do the following: -</p> -<div class="example"> -<pre class="example">$ git format-patch --to=~carbslinux/dev+subscribe@lists.sr.ht -1 --stdout | - msmtp -t -a my-mail -</pre></div> - -<p>You can also send multiple patches by doing the following: -</p> -<div class="example"> -<pre class="example">$ git format-patch --to=~carbslinux/dev+subscribe@lists.sr.ht <region> - -Edit those files as necessary and send them. -$ for file in *.patch; do msmtp -t -a my-mail < $patch; done -</pre></div> - - - - - - - - -</body> -</html> diff --git a/src/docs/Setting-up-an-rsync-repository-for-distribution.html b/src/docs/Setting-up-an-rsync-repository-for-distribution.html deleted file mode 100644 index ff97a37..0000000 --- a/src/docs/Setting-up-an-rsync-repository-for-distribution.html +++ /dev/null @@ -1,109 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Setting up an rsync repository for distribution (Carbs Linux User Manual)</title> - -<meta name="description" content="Setting up an rsync repository for distribution (Carbs Linux User Manual)"> -<meta name="keywords" content="Setting up an rsync repository for distribution (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Rsync-Repositories.html" rel="up" title="Rsync Repositories"> -<link href="Init-System.html" rel="next" title="Init System"> -<link href="Rsync-Repositories.html" rel="prev" title="Rsync Repositories"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Setting-up-an-rsync-repository-for-distribution"></span><div class="header"> -<p> -Up: <a href="Rsync-Repositories.html" accesskey="u" rel="up">Rsync Repositories</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Setting-up-an-rsync-repository-for-distribution-1"></span><h4 class="subsection">2.5.1 Setting up an rsync repository for distribution</h4> - -<p>Carbs Linux repositories automatically sync from the git repostitories and serve -it through the rsync daemon. Here is a sample shell script that I use in order to -sync repositories. Feel free to customize for your own use. -</p> -<pre class="verbatim"> #!/bin/sh - HOSTNAME="rsync://carbslinux.org/repo" - GITDIR="/pub/git/repo" - SHAREDIR="/pub/share/repo" - git -C "$GITDIR" pull - - rsync -avcC --delete --include=core --exclude=.rsync,.rsync_root "$GITDIR/." "$SHAREDIR" - - printf '%s\n' "$HOSTNAME" > "$GITDIR/.rsync" - for dir in "$GITDIR/"*; do - [ -d "$dir" ] || continue - [ -f "$dir/.rsync" ] || - printf '%s/%s\n' "$HOSTNAME" "${dir##*/}" > "$dir/.rsync" - printf '..\n' > "$dir/.rsync_root" - done -</pre> -<p>You can then create an <strong>rsync</strong> user for serving the repositories. -</p> -<div class="example"> -<pre class="example">$ adduser -SD rsync -</pre></div> - -<p>Create <samp>/etc/rsyncd.conf</samp> and a service configuration as well. -</p> -<pre class="verbatim"> - uid = rsync - gid = rsync - address = example.com - max connections = 10 - use chroot = yes - - [repo] - path = /pub/share/repo - comment = My repository -</pre> -<p>Create a service file at <samp>/etc/sv/rsync/run</samp> (runit): -</p> -<div class="example"> -<pre class="example">#!/bin/sh -exec rsync --daemon --no-detach -</pre></div> - - - - - - - -</body> -</html> diff --git a/src/docs/Setting-up-repositories.html b/src/docs/Setting-up-repositories.html new file mode 100644 index 0000000..44360ab --- /dev/null +++ b/src/docs/Setting-up-repositories.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Setting up repositories (Carbs Linux User Manual)</title> + +<meta name="description" content="Setting up repositories (Carbs Linux User Manual)"> +<meta name="keywords" content="Setting up repositories (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Updating-packages.html" rel="next" title="Updating packages"> +<link href="Chroot.html" rel="prev" title="Chroot"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Setting-up-repositories"></span><div class="header"> +<p> +Next: <a href="Updating-packages.html" accesskey="n" rel="next">Updating packages</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Setting-up-repositories-1"></span><h4 class="subsection">1.2.1 Setting up repositories</h4> + +<p>Newest tarballs do not come with repositories, so you will need to manually +obtain them, and set your ‘<samp>CPT_PATH</samp>’ environment variable. Carbs Linux +repositories can either be obtained by ‘<samp>git</samp>’ or ‘<samp>rsync</samp>’. While rsync +repositories are overall faster and smaller, git offers the whole history of the +repository and a means to manipulate your repository as you like it. If you want +to obtain the git repository, you will need to install ‘<samp>git</samp>’ itself. +</p> +<p>The following guide will assume that you put the repositories into ‘<samp>~/repos/</samp>’ +directory, but you can put the repositories into any directory you want. So go +ahead and create that directory: +</p> +<div class="example"> +<pre class="example">mkdir -p $HOME/repos +</pre></div> + +<ol> +<li> Obtaining from git + + +<p>Carbs Linux git repositories can be found both from the main server and GitHub +(mirror). Here are both their repository links. You can clone any of them. +</p> +<ul> +<li> git://git.carbslinux.org/repository +</li><li> <a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a> +</li></ul> + +<div class="example"> +<pre class="example">git clone git://git.carbslinux.org/repository $HOME/repos/carbs +</pre></div> + +</li><li> Obtaining from rsync + + +<p>Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In +order to obtain it, run the following: +</p> +<div class="example"> +<pre class="example">rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs +</pre></div> + +</li><li> Making the package manager use the repositories + + +<p>In your shell’s configuration file, or in your ‘<samp>~/.profile</samp>’ file, add the +following lines: +</p> +<div class="example"> +<pre class="example">CPT_PATH=$HOME/repos/carbs/core +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg +CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community +export CPT_PATH +</pre></div> +</li></ol> + + + + +</body> +</html> diff --git a/src/docs/Shell-Conventions.html b/src/docs/Shell-Conventions.html index cb040d0..dd841de 100644 --- a/src/docs/Shell-Conventions.html +++ b/src/docs/Shell-Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -22,7 +23,7 @@ Documentation License." --> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Conventions.html" rel="up" title="Conventions"> <link href="Repository-Conventions.html" rel="next" title="Repository Conventions"> -<link href="General-Conventions.html" rel="prev" title="General Conventions"> +<link href="Conventions.html" rel="prev" title="Conventions"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -48,57 +49,56 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Shell-Conventions"></span><div class="header"> <p> -Next: <a href="Repository-Conventions.html" accesskey="n" rel="next">Repository Conventions</a>, Previous: <a href="General-Conventions.html" accesskey="p" rel="prev">General Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Next: <a href="Repository-Conventions.html" accesskey="n" rel="next">Repository Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Shell-Conventions-_002d_002d-10"></span><h4 class="subsection">4.1.2 Shell Conventions – 10</h4> +<span id="Shell-Conventions-1"></span><h4 class="subsection">3.1.1 Shell Conventions</h4> <p>Shell is central to Carbs Linux projects. Most of the tools and packages are written in POSIX sh. </p> <dl compact="compact"> -<dt><strong>[<span id="g_t1010"></span>1010]</strong></dt> +<dt>[<span id="g_t1010"></span>1010]</dt> <dd><p>Use 4 spaces for indentation, don’t use tabs. </p></dd> -<dt><strong>[<span id="g_t1020"></span>1020]</strong></dt> +<dt>[<span id="g_t1020"></span>1020]</dt> <dd><p>Make sure you don’t use bash-specific code. </p></dd> -<dt><strong>[<span id="g_t1030"></span>1030]</strong></dt> -<dd><p>Make sure you lint your code with <code>shellcheck</code> and if you are new to -POSIX sh, use <code>checkbashisms</code>. +<dt>[<span id="g_t1030"></span>1030]</dt> +<dd><p>Make sure you lint your code with ‘<samp>shellcheck</samp>’ and if +you are new to POSIX sh, use ‘<samp>checkbashisms</samp>’. </p></dd> -<dt><strong>[<span id="g_t1040"></span>1040]</strong></dt> -<dd><p>Don’t spawn new processes if you don’t absolutely need to, especially during -string manipulation. +<dt>[<span id="g_t1040"></span>1040]</dt> +<dd><p>Don’t spawn new processes if you don’t absolutely need +to, especially during string manipulation. </p><dl compact="compact"> -<dt><strong>[<span id="g_t1041"></span>1041]</strong></dt> -<dd><p>Never use a program for text manupilation that isn’t defined in the POSIX -standard. This includes <code>gawk</code> and <code>perl</code>. +<dt>[<span id="g_t1041"></span>1041]</dt> +<dd><p>Never use a program for text manupilation that isn’t +defined in the POSIX standard. This includes ‘<samp>gawk</samp>’ and ‘<samp>perl</samp>’. </p></dd> -<dt><strong>[<span id="g_t1042"></span>1042]</strong></dt> +<dt>[<span id="g_t1042"></span>1042]</dt> <dd><p>Instead of <code>$(basename $file)</code>, use <code>${file##*}</code>. </p></dd> -<dt><strong>[<span id="g_t1043"></span>1043]</strong></dt> +<dt>[<span id="g_t1043"></span>1043]</dt> <dd><p>Instead of <code>$(dirname $file)</code>, use <code>${file%/*}</code>. </p></dd> </dl> + <div class="example"> -<pre class="example"># This is the same thing as <code>basename /path/to/test.asc .asc</code> +<pre class="example"># This is the same thing as basename /path/to/test.asc .asc $ file=/path/to/test.asc file=${file##*/} file=${file%.asc} $ echo $file test </pre></div> </dd> -<dt><strong>[<span id="g_t1050"></span>1050]</strong></dt> -<dd><p>Instead of backticks, use <tt>$(..)</tt>. +<dt>[<span id="g_t1050"></span>1050]</dt> +<dd><p>Instead of backticks, use <code>$(..)</code>. </p></dd> </dl> - - </body> </html> diff --git a/src/docs/Signature-verification.html b/src/docs/Signature-verification.html new file mode 100644 index 0000000..8dccbe3 --- /dev/null +++ b/src/docs/Signature-verification.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Signature verification (Carbs Linux User Manual)</title> + +<meta name="description" content="Signature verification (Carbs Linux User Manual)"> +<meta name="keywords" content="Signature verification (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Preparing-Environment.html" rel="up" title="Preparing Environment"> +<link href="Extracting-the-tarball.html" rel="next" title="Extracting the tarball"> +<link href="Download.html" rel="prev" title="Download"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Signature-verification"></span><div class="header"> +<p> +Next: <a href="Extracting-the-tarball.html" accesskey="n" rel="next">Extracting the tarball</a>, Previous: <a href="Download.html" accesskey="p" rel="prev">Download</a>, Up: <a href="Preparing-Environment.html" accesskey="u" rel="up">Preparing Environment</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Signature-verification-1"></span><h4 class="subsection">1.1.2 Signature verification</h4> + +<p>It is highly recommended to verify the signature of the tarball. You will need +GPG for this. +</p> +<div class="example"> +<pre class="example">wget $URL/carbs-rootfs.tar.xz.sig +gpg --recv-keys FF484BDFEFCEF8FF +gpg --verify carbs-rootfs.tar.xz.sig +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/System-Configuration.html b/src/docs/System-Configuration.html index f0cbaf5..76cf410 100644 --- a/src/docs/System-Configuration.html +++ b/src/docs/System-Configuration.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,8 +22,8 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Installation.html" rel="up" title="Installation"> -<link href="Kernel.html" rel="next" title="Kernel"> -<link href="Chroot.html" rel="prev" title="Chroot"> +<link href="Configuring-hostname.html" rel="next" title="Configuring hostname"> +<link href="Obtaining-the-documentation.html" rel="prev" title="Obtaining the documentation"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -56,31 +57,12 @@ Next: <a href="Kernel.html" accesskey="n" rel="next">Kernel</a>, Previous: <a hr <p>After you have finished installing some extra packages, you can configure your system to your liking. </p> - - -<span id="Configuring-hostname-_0028recommended_0029"></span><h4 class="subsection">1.3.1 Configuring hostname (recommended)</h4> - -<p>You might want to add a hostname, especially in a networked environment. Your -hostname will default to ’carbslinux’ unless you set this. -</p> -<div class="example"> -<pre class="example">$ echo your-hostname > /etc/hostname -</pre></div> - - - -<span id="Setting-up-hosts-file-_0028optional_0029"></span><h4 class="subsection">1.3.2 Setting up hosts file (optional)</h4> - -<p>You can edit your /etc/hosts file, which is the static lookup table for host -names. By default, there are two entries for localhost which are OKAY. You can -replace the ’localhost’ part of these entries to your hostname. -</p> -<div class="example"> -<pre class="example">127.0.0.1 localhost.localdomain localhost -::1 localhost.localdomain localhost ip6-localhost -</pre></div> - - +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Configuring-hostname.html" accesskey="1">Configuring hostname</a></td><td> </td><td align="left" valign="top">Setting up system hostname (recommended) +</td></tr> +<tr><td align="left" valign="top">• <a href="Hosts-file.html" accesskey="2">Hosts file</a></td><td> </td><td align="left" valign="top">Setting up hosts file for networking (optional) +</td></tr> +</table> diff --git a/src/docs/Updating-packages.html b/src/docs/Updating-packages.html new file mode 100644 index 0000000..0c65553 --- /dev/null +++ b/src/docs/Updating-packages.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Updating packages (Carbs Linux User Manual)</title> + +<meta name="description" content="Updating packages (Carbs Linux User Manual)"> +<meta name="keywords" content="Updating packages (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Chroot.html" rel="up" title="Chroot"> +<link href="Installing-packages.html" rel="next" title="Installing packages"> +<link href="Setting-up-repositories.html" rel="prev" title="Setting up repositories"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="Updating-packages"></span><div class="header"> +<p> +Next: <a href="Installing-packages.html" accesskey="n" rel="next">Installing packages</a>, Previous: <a href="Setting-up-repositories.html" accesskey="p" rel="prev">Setting up repositories</a>, Up: <a href="Chroot.html" accesskey="u" rel="up">Chroot</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Updating-packages-1"></span><h4 class="subsection">1.2.2 Updating packages</h4> + +<p>It is good practice to make sure your system is up to date, especially before +building new packages. If there is an update for the package manager you will +need to update twice. +</p> +<div class="example"> +<pre class="example">cpt-update && cpt-update +</pre></div> + + + + +</body> +</html> diff --git a/src/docs/Usage.html b/src/docs/Usage.html deleted file mode 100644 index 65ade0d..0000000 --- a/src/docs/Usage.html +++ /dev/null @@ -1,138 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Usage (Carbs Linux User Manual)</title> - -<meta name="description" content="Usage (Carbs Linux User Manual)"> -<meta name="keywords" content="Usage (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Package-Manager.html" rel="up" title="Package Manager"> -<link href="cpt_002dalternatives.html" rel="next" title="cpt-alternatives"> -<link href="Package-Manager.html" rel="prev" title="Package Manager"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="Usage"></span><div class="header"> -<p> -Next: <a href="Environment-Variables.html" accesskey="n" rel="next">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="Usage-1"></span><h3 class="section">2.1 Usage</h3> - -<p><code>cpt</code> is formed of many tools combined in a single environment, similar -to <code>git</code>. When you run <code>cpt</code> without any arguments, it will show -all available tools and their explanations. Here is an example call with extra -scripts on my system: -</p> -<div class="example"> -<pre class="example">-> Carbs Packaging Tool --> add Commit the current directory as a new package --> alternatives List and swap to alternatives --> build Build a package --> bump Commit the current directory as a version bump --> cargo-urlgen Create static cargo sources for Rust packages --> cargolock-urlgen Convert the given Cargo.lock file to sources --> cat Concatanate package files in the installed package database --> changelog Print the git log of the specific package --> chbuild Create/destroy temporary chroots --> checkmissing Verify package manifests --> checksum Generate checksums --> chroot Enter a chroot --> commit Commit a package without the prefix of 'package:' --> depends Display a package's dependencies --> download Download sources for the given package --> exec Execute a command inside the alternatives system --> export Turn an installed package into a CPT tarball --> fetch Fetch repositories --> fork Fork a package to the current directory --> getchoice Prints the full path to a file in the alternatives system. --> install Install a package --> link Link a forked package's files to the other repository --> list List installed packages --> maintainer Find the maintainer of a package --> manifest Display all files owned by a package --> manifest-tree Display all files owned by a package with a tree view --> new Create a boilerplate CPT package --> orphans List orphaned packages --> owns Check which package owns a file --> rel Bump the release number of a package --> remove Remove a package --> repodepends Display a package's dependencies in the repository --> reporevdepends Display packages on the repository which depend on package --> reset Remove all packages except for the base --> revdepends Display packages which depend on package --> search Search for a package --> size Show the size on disk for a package --> source Extract sources of a given package to the current directory --> update Check for updates -</pre></div> - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="cpt_002dalternatives.html" accesskey="1"><code>cpt-alternatives</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dbuild.html" accesskey="2"><code>cpt-build</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dchecksum.html" accesskey="3"><code>cpt-checksum</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002ddownload.html" accesskey="4"><code>cpt-download</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dfetch.html" accesskey="5"><code>cpt-fetch</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dinstall.html" accesskey="6"><code>cpt-install</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dlist.html" accesskey="7"><code>cpt-list</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dremove.html" accesskey="8"><code>cpt-remove</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dsearch.html" accesskey="9"><code>cpt-search</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="cpt_002dupdate.html"><code>cpt-update</code></a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - - - -<hr> -<div class="header"> -<p> -Next: <a href="Environment-Variables.html" accesskey="n" rel="next">Environment Variables</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> - - - -</body> -</html> diff --git a/src/docs/_002fetc_002finit_002frcconf-file.html b/src/docs/_002fetc_002finit_002frcconf-file.html new file mode 100644 index 0000000..5f33c04 --- /dev/null +++ b/src/docs/_002fetc_002finit_002frcconf-file.html @@ -0,0 +1,66 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>/etc/init/rcconf file (Carbs Linux User Manual)</title> + +<meta name="description" content="/etc/init/rcconf file (Carbs Linux User Manual)"> +<meta name="keywords" content="/etc/init/rcconf file (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Configuring-Init.html" rel="up" title="Configuring Init"> +<link href="Init-Hooks.html" rel="next" title="Init Hooks"> +<link href="Kernel-Command-Line.html" rel="prev" title="Kernel Command Line"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<span id="g_t_002fetc_002finit_002frcconf-file"></span><div class="header"> +<p> +Next: <a href="Init-Hooks.html" accesskey="n" rel="next">Init Hooks</a>, Previous: <a href="Kernel-Command-Line.html" accesskey="p" rel="prev">Kernel Command Line</a>, Up: <a href="Configuring-Init.html" accesskey="u" rel="up">Configuring Init</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="g_t_002fetc_002finit_002frc_002econf-file"></span><h4 class="subsection">2.1.2 ‘<samp>/etc/init/rc.conf</samp>’ file</h4> + +<p>However, the kernel command line isn’t the only place to set your boot +parameters. You can specify variables here as well, although note that the +kernel command line always gets the priority for these variables since they can +be set just before boot. +</p> + + + +</body> +</html> diff --git a/src/docs/cpt_002dbuild.html b/src/docs/cpt_002dbuild.html deleted file mode 100644 index c15e41c..0000000 --- a/src/docs/cpt_002dbuild.html +++ /dev/null @@ -1,78 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-build (Carbs Linux User Manual)</title> - -<meta name="description" content="cpt-build (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-build (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dchecksum.html" rel="next" title="cpt-checksum"> -<link href="cpt_002dalternatives.html" rel="prev" title="cpt-alternatives"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="cpt_002dbuild"></span><div class="header"> -<p> -Next: <a href="cpt_002dchecksum.html" accesskey="n" rel="next"><code>cpt-checksum</code></a>, Previous: <a href="cpt_002dalternatives.html" accesskey="p" rel="prev"><code>cpt-alternatives</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="cpt_002dbuild-1"></span><h4 class="subsection">2.1.2 <code>cpt-build</code></h4> - -<p><code>cpt-build</code> will build given packages and their dependencies. If -multiple packages are specified, it will ask to install the packages as well. -</p> - - -<span id="Options"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-y --no-prompt</samp></dt> -<dd><p>Do not prompt for confirmation -</p></dd> -<dt><samp>-t --test</samp></dt> -<dd><p>Run tests (if it exists) -</p></dd> -</dl> - - - - - - -</body> -</html> diff --git a/src/docs/cpt_002dinstall.html b/src/docs/cpt_002dinstall.html deleted file mode 100644 index ed82923..0000000 --- a/src/docs/cpt_002dinstall.html +++ /dev/null @@ -1,77 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-install (Carbs Linux User Manual)</title> - -<meta name="description" content="cpt-install (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-install (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dlist.html" rel="next" title="cpt-list"> -<link href="cpt_002dfetch.html" rel="prev" title="cpt-fetch"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="cpt_002dinstall"></span><div class="header"> -<p> -Next: <a href="cpt_002dlist.html" accesskey="n" rel="next"><code>cpt-list</code></a>, Previous: <a href="cpt_002dfetch.html" accesskey="p" rel="prev"><code>cpt-fetch</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="cpt_002dinstall-1"></span><h4 class="subsection">2.1.6 <code>cpt-install</code></h4> - -<p><code>cpt-install</code> will install given packages. -</p> - - -<span id="Options-1"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-f --force</samp></dt> -<dd><p>Force installation. See <a href="Environment-Variables.html#cptforce"><code>CPT_FORCE</code></a>. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Set an alternative root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - - - - - -</body> -</html> diff --git a/src/docs/cpt_002dremove.html b/src/docs/cpt_002dremove.html deleted file mode 100644 index 93a7ff8..0000000 --- a/src/docs/cpt_002dremove.html +++ /dev/null @@ -1,77 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-remove (Carbs Linux User Manual)</title> - -<meta name="description" content="cpt-remove (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-remove (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="cpt_002dsearch.html" rel="next" title="cpt-search"> -<link href="cpt_002dlist.html" rel="prev" title="cpt-list"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="cpt_002dremove"></span><div class="header"> -<p> -Next: <a href="cpt_002dsearch.html" accesskey="n" rel="next"><code>cpt-search</code></a>, Previous: <a href="cpt_002dlist.html" accesskey="p" rel="prev"><code>cpt-list</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="cpt_002dremove-1"></span><h4 class="subsection">2.1.8 <code>cpt-remove</code></h4> - -<p><code>cpt-remove</code> will remove given packages. -</p> - - -<span id="Options-2"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-f --force</samp></dt> -<dd><p>Force removal. See <a href="Environment-Variables.html#cptforce"><code>CPT_FORCE</code></a>. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Set an alternative root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - - - - - -</body> -</html> diff --git a/src/docs/cpt_002dupdate.html b/src/docs/cpt_002dupdate.html deleted file mode 100644 index 7446855..0000000 --- a/src/docs/cpt_002dupdate.html +++ /dev/null @@ -1,83 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cpt-update (Carbs Linux User Manual)</title> - -<meta name="description" content="cpt-update (Carbs Linux User Manual)"> -<meta name="keywords" content="cpt-update (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Usage.html" rel="up" title="Usage"> -<link href="Environment-Variables.html" rel="next" title="Environment Variables"> -<link href="cpt_002dsearch.html" rel="prev" title="cpt-search"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - - -</head> - -<body lang="en"> -<span id="cpt_002dupdate"></span><div class="header"> -<p> -Previous: <a href="cpt_002dsearch.html" accesskey="p" rel="prev"><code>cpt-search</code></a>, Up: <a href="Usage.html" accesskey="u" rel="up">Usage</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> -</div> -<hr> -<span id="cpt_002dupdate-1"></span><h4 class="subsection">2.1.10 <code>cpt-update</code></h4> - -<p><code>cpt-update</code> will update the packages on your system. -</p> - - -<span id="Options-4"></span><h4 class="unnumberedsubsubsec">Options</h4> - -<dl compact="compact"> -<dt><samp>-d --download</samp></dt> -<dd><p>Only download updatable packages. -</p></dd> -<dt><samp>-n --no-fetch</samp></dt> -<dd><p>Do not fetch remote repositories. -</p></dd> -<dt><samp>-y --no-prompt</samp></dt> -<dd><p>Do not prompt for confirmation. -</p></dd> -<dt><samp>--root</samp></dt> -<dd><p>Use an alternate root directory. See <a href="Environment-Variables.html#cptroot"><code>CPT_ROOT</code></a>. -</p></dd> -</dl> - - - - - - -</body> -</html> diff --git a/src/docs/cptforce.html b/src/docs/cptforce.html deleted file mode 100644 index 531869a..0000000 --- a/src/docs/cptforce.html +++ /dev/null @@ -1,48 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<!-- This file redirects to the location of a node or anchor --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cptforce (Carbs Linux User Manual)</title> - -<meta name="description" content="cptforce (Carbs Linux User Manual)"> -<meta name="keywords" content="cptforce (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - -<meta http-equiv="Refresh" content="0; url=Environment-Variables.html#cptforce"> - -</head> - -<body lang="en"> - -<p>The node you are looking for is at <a href="Environment-Variables.html#cptforce">cptforce</a>.</p> -</body> diff --git a/src/docs/cptroot.html b/src/docs/cptroot.html deleted file mode 100644 index 3e9dfbe..0000000 --- a/src/docs/cptroot.html +++ /dev/null @@ -1,48 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2020 Cem Keylan - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU Free -Documentation License." --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<!-- This file redirects to the location of a node or anchor --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>cptroot (Carbs Linux User Manual)</title> - -<meta name="description" content="cptroot (Carbs Linux User Manual)"> -<meta name="keywords" content="cptroot (Carbs Linux User Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} ---> -</style> - -<meta http-equiv="Refresh" content="0; url=Environment-Variables.html#cptroot"> - -</head> - -<body lang="en"> - -<p>The node you are looking for is at <a href="Environment-Variables.html#cptroot">cptroot</a>.</p> -</body> diff --git a/src/docs/index.html b/src/docs/index.html index 9511f59..68cef39 100644 --- a/src/docs/index.html +++ b/src/docs/index.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -49,19 +50,6 @@ ul.no-bullet {list-style: none} -<span id="SEC_Overview"></span> -<h2 class="shortcontents-heading">Short Table of Contents</h2> - -<div class="shortcontents"> -<ul class="no-bullet"> -<li><a id="stoc-Installation-1" href="#toc-Installation-1">1 Installation</a></li> -<li><a id="stoc-Package-Manager-1" href="#toc-Package-Manager-1">2 Package Manager</a></li> -<li><a id="stoc-Init-System-1" href="#toc-Init-System-1">3 Init System</a></li> -<li><a id="stoc-Contribution-Guidelines-1" href="#toc-Contribution-Guidelines-1">4 Contribution Guidelines</a></li> -<li><a id="stoc-GNU-Free-Documentation-License-1" href="#toc-GNU-Free-Documentation-License-1">GNU Free Documentation License</a></li> -</ul> -</div> - <span id="SEC_Contents"></span> <h2 class="contents-heading">Table of Contents</h2> @@ -72,130 +60,70 @@ ul.no-bullet {list-style: none} <ul class="no-bullet"> <li><a id="toc-Preparing-Environment-1" href="Preparing-Environment.html#Preparing-Environment">1.1 Preparing Environment</a> <ul class="no-bullet"> - <li><a id="toc-Download" href="Preparing-Environment.html#Download">1.1.1 Download</a></li> - <li><a id="toc-Check-the-integrity-of-the-tarball-_0028Recommended_0029" href="Preparing-Environment.html#Check-the-integrity-of-the-tarball-_0028Recommended_0029">1.1.2 Check the integrity of the tarball (Recommended)</a></li> - <li><a id="toc-Verify-the-signature" href="Preparing-Environment.html#Verify-the-signature">1.1.3 Verify the signature</a></li> - <li><a id="toc-Extracting-the-tarball" href="Preparing-Environment.html#Extracting-the-tarball">1.1.4 Extracting the tarball</a></li> - <li><a id="toc-Obtain-the-chroot-helper" href="Preparing-Environment.html#Obtain-the-chroot-helper">1.1.5 Obtain the chroot helper</a></li> + <li><a id="toc-Download-1" href="Download.html#Download">1.1.1 Download</a></li> + <li><a id="toc-Signature-verification-1" href="Signature-verification.html#Signature-verification">1.1.2 Signature verification</a></li> + <li><a id="toc-Extracting-the-tarball-1" href="Extracting-the-tarball.html#Extracting-the-tarball">1.1.3 Extracting the tarball</a></li> + <li><a id="toc-Obtain-the-chroot-helper-1" href="Obtain-the-chroot-helper.html#Obtain-the-chroot-helper">1.1.4 Obtain the chroot helper</a></li> </ul></li> <li><a id="toc-Chroot-1" href="Chroot.html#Chroot">1.2 Chroot</a> <ul class="no-bullet"> - <li><a id="toc-Setting-up-repositories" href="Chroot.html#Setting-up-repositories">1.2.1 Setting up repositories</a> - <ul class="no-bullet"> - <li><a id="toc-Obtaining-from-rsync" href="Chroot.html#Obtaining-from-rsync">1.2.1.1 Obtaining from rsync</a></li> - <li><a id="toc-Obtaining-from-git" href="Chroot.html#Obtaining-from-git">1.2.1.2 Obtaining from git</a></li> - <li><a id="toc-Making-the-package-manager-use-the-repositories" href="Chroot.html#Making-the-package-manager-use-the-repositories">1.2.1.3 Making the package manager use the repositories</a></li> - </ul></li> - <li><a id="toc-Updating-packages" href="Chroot.html#Updating-packages">1.2.2 Updating packages</a></li> - <li><a id="toc-Installing-packages" href="Chroot.html#Installing-packages">1.2.3 Installing packages</a></li> - <li><a id="toc-Essential-Software" href="Chroot.html#Essential-Software">1.2.4 Essential Software</a></li> - <li><a id="toc-Obtaining-the-documentation-_0028optional_0029" href="Chroot.html#Obtaining-the-documentation-_0028optional_0029">1.2.5 Obtaining the documentation (optional)</a></li> + <li><a id="toc-Setting-up-repositories-1" href="Setting-up-repositories.html#Setting-up-repositories">1.2.1 Setting up repositories</a></li> + <li><a id="toc-Updating-packages-1" href="Updating-packages.html#Updating-packages">1.2.2 Updating packages</a></li> + <li><a id="toc-Installing-packages-1" href="Installing-packages.html#Installing-packages">1.2.3 Installing packages</a></li> + <li><a id="toc-Essential-Software-1" href="Essential-Software.html#Essential-Software">1.2.4 Essential Software</a></li> + <li><a id="toc-Obtaining-the-documentation-1" href="Obtaining-the-documentation.html#Obtaining-the-documentation">1.2.5 Obtaining the documentation</a></li> </ul></li> <li><a id="toc-System-Configuration-1" href="System-Configuration.html#System-Configuration">1.3 System Configuration</a> <ul class="no-bullet"> - <li><a id="toc-Configuring-hostname-_0028recommended_0029" href="System-Configuration.html#Configuring-hostname-_0028recommended_0029">1.3.1 Configuring hostname (recommended)</a></li> - <li><a id="toc-Setting-up-hosts-file-_0028optional_0029" href="System-Configuration.html#Setting-up-hosts-file-_0028optional_0029">1.3.2 Setting up hosts file (optional)</a></li> + <li><a id="toc-Configuring-hostname-1" href="Configuring-hostname.html#Configuring-hostname">1.3.1 Configuring hostname</a></li> + <li><a id="toc-Hosts-file-1" href="Hosts-file.html#Hosts-file">1.3.2 Hosts file</a></li> </ul></li> <li><a id="toc-Kernel-1" href="Kernel.html#Kernel">1.4 Kernel</a> <ul class="no-bullet"> - <li><a id="toc-Obtaining-the-kernel-sources" href="Kernel.html#Obtaining-the-kernel-sources">1.4.1 Obtaining the kernel sources</a></li> - <li><a id="toc-Installing-dependencies" href="Kernel.html#Installing-dependencies">1.4.2 Installing dependencies</a></li> - <li><a id="toc-Compiling-the-kernel" href="Kernel.html#Compiling-the-kernel">1.4.3 Compiling the kernel</a></li> + <li><a id="toc-Obtaining-the-kernel-sources-1" href="Obtaining-the-kernel-sources.html#Obtaining-the-kernel-sources">1.4.1 Obtaining the kernel sources</a></li> + <li><a id="toc-Kernel-dependencies-1" href="Kernel-dependencies.html#Kernel-dependencies">1.4.2 Kernel dependencies</a></li> + <li><a id="toc-Building-the-kernel-1" href="Building-the-kernel.html#Building-the-kernel">1.4.3 Building the kernel</a></li> </ul></li> <li><a id="toc-Making-your-system-bootable-1" href="Making-your-system-bootable.html#Making-your-system-bootable">1.5 Making your system bootable</a> <ul class="no-bullet"> - <li><a id="toc-Installing-a-bootloader" href="Making-your-system-bootable.html#Installing-a-bootloader">1.5.1 Installing a bootloader</a></li> - <li><a id="toc-Installing-init-scripts" href="Making-your-system-bootable.html#Installing-init-scripts">1.5.2 Installing init scripts</a></li> - <li><a id="toc-Generating-fstab" href="Making-your-system-bootable.html#Generating-fstab">1.5.3 Generating fstab</a></li> + <li><a id="toc-Bootloader-1" href="Bootloader.html#Bootloader">1.5.1 Bootloader</a></li> + <li><a id="toc-Init-scripts-1" href="Init-scripts.html#Init-scripts">1.5.2 Init scripts</a></li> + <li><a id="toc-Fstab-1" href="Fstab.html#Fstab">1.5.3 Fstab</a></li> </ul></li> <li><a id="toc-Post_002dinstallation-1" href="Post_002dinstallation.html#Post_002dinstallation">1.6 Post-installation</a> <ul class="no-bullet"> - <li><a id="toc-Acquiring-kiss-repositories" href="Post_002dinstallation.html#Acquiring-kiss-repositories">1.6.1 Acquiring kiss repositories</a></li> + <li><a id="toc-KISS-repositories-1" href="KISS-repositories.html#KISS-repositories">1.6.1 KISS repositories</a></li> </ul></li> </ul></li> - <li><a id="toc-Package-Manager-1" href="Package-Manager.html#Package-Manager">2 Package Manager</a> + <li><a id="toc-Init-System-1" href="Init-System.html#Init-System">2 Init System</a> <ul class="no-bullet"> - <li><a id="toc-Usage-1" href="Usage.html#Usage">2.1 Usage</a> - <ul class="no-bullet"> - <li><a id="toc-cpt_002dalternatives-1" href="cpt_002dalternatives.html#cpt_002dalternatives">2.1.1 <code>cpt-alternatives</code></a> - <ul class="no-bullet"> - <li><a id="toc-Examples" href="cpt_002dalternatives.html#Examples">Examples</a></li> - </ul></li> - <li><a id="toc-cpt_002dbuild-1" href="cpt_002dbuild.html#cpt_002dbuild">2.1.2 <code>cpt-build</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options" href="cpt_002dbuild.html#Options">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dchecksum-1" href="cpt_002dchecksum.html#cpt_002dchecksum">2.1.3 <code>cpt-checksum</code></a></li> - <li><a id="toc-cpt_002ddownload-1" href="cpt_002ddownload.html#cpt_002ddownload">2.1.4 <code>cpt-download</code></a></li> - <li><a id="toc-cpt_002dfetch-1" href="cpt_002dfetch.html#cpt_002dfetch">2.1.5 <code>cpt-fetch</code></a></li> - <li><a id="toc-cpt_002dinstall-1" href="cpt_002dinstall.html#cpt_002dinstall">2.1.6 <code>cpt-install</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-1" href="cpt_002dinstall.html#Options-1">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dlist-1" href="cpt_002dlist.html#cpt_002dlist">2.1.7 <code>cpt-list</code></a></li> - <li><a id="toc-cpt_002dremove-1" href="cpt_002dremove.html#cpt_002dremove">2.1.8 <code>cpt-remove</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-2" href="cpt_002dremove.html#Options-2">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dsearch-1" href="cpt_002dsearch.html#cpt_002dsearch">2.1.9 <code>cpt-search</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-3" href="cpt_002dsearch.html#Options-3">Options</a></li> - </ul></li> - <li><a id="toc-cpt_002dupdate-1" href="cpt_002dupdate.html#cpt_002dupdate">2.1.10 <code>cpt-update</code></a> - <ul class="no-bullet"> - <li><a id="toc-Options-4" href="cpt_002dupdate.html#Options-4">Options</a></li> - </ul></li> - </ul></li> - <li><a id="toc-Environment-Variables-1" href="Environment-Variables.html#Environment-Variables">2.2 Environment Variables</a></li> - <li><a id="toc-Hooks-1" href="Hooks.html#Hooks">2.3 Hooks</a> + <li><a id="toc-Configuring-Init-1" href="Configuring-Init.html#Configuring-Init">2.1 Configuring Init</a> <ul class="no-bullet"> - <li><a id="toc-Editing-the-build-file-during-pre_002dbuild-1" href="Editing-the-build-file-during-pre_002dbuild.html#Editing-the-build-file-during-pre_002dbuild">2.3.1 Editing the <samp>build</samp> file during pre-build</a></li> + <li><a id="toc-Kernel-Command-Line-1" href="Kernel-Command-Line.html#Kernel-Command-Line">2.1.1 Kernel Command Line</a></li> + <li><a id="toc-_002fetc_002finit_002frc_002econf-file" href="_002fetc_002finit_002frcconf-file.html#g_t_002fetc_002finit_002frcconf-file">2.1.2 ‘<samp>/etc/init/rc.conf</samp>’ file</a></li> + <li><a id="toc-Init-Hooks-1" href="Init-Hooks.html#Init-Hooks">2.1.3 Init Hooks</a></li> </ul></li> - <li><a id="toc-Packaging-System-1" href="Packaging-System.html#Packaging-System">2.4 Packaging System</a> + <li><a id="toc-Changing-Init-Program-1" href="Changing-Init-Program.html#Changing-Init-Program">2.2 Changing Init Program</a> <ul class="no-bullet"> - <li><a id="toc-build" href="Packaging-System.html#build">2.4.1 <samp>build</samp></a></li> - <li><a id="toc-sources" href="Packaging-System.html#sources">2.4.2 <samp>sources</samp></a></li> - <li><a id="toc-checksums" href="Packaging-System.html#checksums">2.4.3 <samp>checksums</samp></a></li> - <li><a id="toc-version" href="Packaging-System.html#version">2.4.4 <samp>version</samp></a></li> - <li><a id="toc-depends" href="Packaging-System.html#depends">2.4.5 <samp>depends</samp></a></li> - <li><a id="toc-post_002dinstall" href="Packaging-System.html#post_002dinstall">2.4.6 <samp>post-install</samp></a></li> - <li><a id="toc-message" href="Packaging-System.html#message">2.4.7 <samp>message</samp></a></li> - <li><a id="toc-test" href="Packaging-System.html#test">2.4.8 <samp>test</samp></a></li> - </ul></li> - <li><a id="toc-Rsync-Repositories-1" href="Rsync-Repositories.html#Rsync-Repositories">2.5 Rsync Repositories</a> - <ul class="no-bullet"> - <li><a id="toc-Setting-up-an-rsync-repository-for-distribution-1" href="Setting-up-an-rsync-repository-for-distribution.html#Setting-up-an-rsync-repository-for-distribution">2.5.1 Setting up an rsync repository for distribution</a></li> + <li><a id="toc-Rebooting-after-changing-init-1" href="Rebooting-after-changing-init.html#Rebooting-after-changing-init">2.2.1 Rebooting after changing init</a></li> </ul></li> </ul></li> - <li><a id="toc-Init-System-1" href="Init-System.html#Init-System">3 Init System</a> + <li><a id="toc-Contribution-Guidelines-1" href="Contribution-Guidelines.html#Contribution-Guidelines">3 Contribution Guidelines</a> <ul class="no-bullet"> - <li><a id="toc-Configuring-Init-1" href="Configuring-Init.html#Configuring-Init">3.1 Configuring Init</a> - <ul class="no-bullet"> - <li><a id="toc-Kernel-Command-Line" href="Configuring-Init.html#Kernel-Command-Line">3.1.1 Kernel Command Line</a></li> - <li><a id="toc-_002fetc_002finit_002frc_002econf-file" href="Configuring-Init.html#g_t_002fetc_002finit_002frc_002econf-file">3.1.2 <samp>/etc/init/rc.conf</samp> file</a></li> - </ul></li> - <li><a id="toc-Init-Hooks-1" href="Init-Hooks.html#Init-Hooks">3.2 Init Hooks</a></li> - <li><a id="toc-Changing-Init-Program-1" href="Changing-Init-Program.html#Changing-Init-Program">3.3 Changing Init Program</a> + <li><a id="toc-Conventions-1" href="Conventions.html#Conventions">3.1 Conventions</a> <ul class="no-bullet"> - <li><a id="toc-Rebooting-after-changing-Init" href="Changing-Init-Program.html#Rebooting-after-changing-Init">3.3.1 Rebooting after changing Init</a></li> + <li><a id="toc-Shell-Conventions-1" href="Shell-Conventions.html#Shell-Conventions">3.1.1 Shell Conventions</a></li> + <li><a id="toc-Repository-Conventions-1" href="Repository-Conventions.html#Repository-Conventions">3.1.2 Repository Conventions</a></li> </ul></li> </ul></li> - <li><a id="toc-Contribution-Guidelines-1" href="Contribution-Guidelines.html#Contribution-Guidelines">4 Contribution Guidelines</a> + <li><a id="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a> <ul class="no-bullet"> - <li><a id="toc-Conventions-1" href="Conventions.html#Conventions">4.1 Conventions</a> - <ul class="no-bullet"> - <li><a id="toc-General-Conventions-_002d_002d-00" href="General-Conventions.html#General-Conventions">4.1.1 General Conventions – 00</a></li> - <li><a id="toc-Shell-Conventions-_002d_002d-10" href="Shell-Conventions.html#Shell-Conventions">4.1.2 Shell Conventions – 10</a></li> - <li><a id="toc-Repository-Conventions-_002d_002d-20" href="Repository-Conventions.html#Repository-Conventions">4.1.3 Repository Conventions – 20</a></li> - </ul></li> - <li><a id="toc-Sending-Git-mails-1" href="Sending-Git-mails.html#Sending-Git-mails">4.2 Sending Git mails</a></li> + <li><a id="toc-ADDENDUM_003a-How-to-use-this-License-for-your-documents" href="GNU-Free-Documentation-License.html#ADDENDUM_003a-How-to-use-this-License-for-your-documents">A.1 ADDENDUM: How to use this License for your documents</a></li> </ul></li> - <li><a id="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU Free Documentation License</a></li> </ul> </div> - <span id="Top"></span><div class="header"> <p> Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> @@ -203,9 +131,8 @@ Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> &nbs <hr> <span id="Carbs-Linux-User-Manual"></span><h1 class="top">Carbs Linux User Manual</h1> -<p>This is the full documentation of <a href="https://carbslinux.org">Carbs Linux</a>, -from the details of the distribution, installation, to the package manager. It -is not yet complete. +<p>This is the full documentation of <a href="https://carbslinux.org">Carbs Linux</a>, from the details of the +distribution, installation, to the package manager. It is not yet complete. </p> <p>This documentation is also available in the distribution by the @@ -214,53 +141,92 @@ is not yet complete. favorite pager. You can install either the <code>info</code> or <code>texinfo</code> for doing the first. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Installation.html" accesskey="1">Installation</a></td><td> </td><td align="left" valign="top">Installing Carbs Linux +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-System.html" accesskey="2">Init System</a></td><td> </td><td align="left" valign="top">Configure the init system +</td></tr> +<tr><td align="left" valign="top">• <a href="Contribution-Guidelines.html" accesskey="3">Contribution Guidelines</a></td><td> </td><td align="left" valign="top">Contribute to Carbs Linux +</td></tr> +<tr><td align="left" valign="top">• <a href="GNU-Free-Documentation-License.html" accesskey="4">GNU Free Documentation License</a></td><td> </td><td align="left" valign="top">Your rights +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">— The Detailed Node Listing — +Installation -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="Installation.html" accesskey="1">Installation</a></td><td> </td><td align="left" valign="top">Installing Carbs Linux +</pre></th></tr><tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="5">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot +</td></tr> +<tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="6">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system </td></tr> -<tr><td align="left" valign="top">• <a href="Package-Manager.html" accesskey="2">Package Manager</a></td><td> </td><td align="left" valign="top">Carbs Linux Packaging Tools +<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="7">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing your system for personal use </td></tr> -<tr><td align="left" valign="top">• <a href="Init-System.html" accesskey="3">Init System</a></td><td> </td><td align="left" valign="top">Configuring the init system +<tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="8">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Contribution-Guidelines.html" accesskey="4">Contribution Guidelines</a></td><td> </td><td align="left" valign="top">Contributing to Carbs Linux +<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html" accesskey="9">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing bootloader and boot scripts </td></tr> -<tr><td align="left" valign="top">• <a href="GNU-Free-Documentation-License.html" accesskey="5">GNU Free Documentation License</a></td><td> </td><td align="left" valign="top">Copying Conditions +<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html">Post-installation</a></td><td> </td><td align="left" valign="top">Post-installation tasks </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +Preparing Environment -— Detailed Menu Listing — +</pre></th></tr><tr><td align="left" valign="top">• <a href="Download.html">Download</a></td><td> </td><td align="left" valign="top">Download the root filesystem tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Signature-verification.html">Signature verification</a></td><td> </td><td align="left" valign="top">Verify the signature of the rootfs tarball +</td></tr> +<tr><td align="left" valign="top">• <a href="Extracting-the-tarball.html">Extracting the tarball</a></td><td> </td><td align="left" valign="top">Extracting the root filesystem to the desired location +</td></tr> +<tr><td align="left" valign="top">• <a href="Obtain-the-chroot-helper.html">Obtain the chroot helper</a></td><td> </td><td align="left" valign="top">Download the script to easily chroot into the new filesystem +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -Installation +Chroot -</pre></th></tr><tr><td align="left" valign="top">• <a href="Preparing-Environment.html" accesskey="6">Preparing Environment</a></td><td> </td><td align="left" valign="top">Getting ready to chroot +</pre></th></tr><tr><td align="left" valign="top">• <a href="Setting-up-repositories.html">Setting up repositories</a></td><td> </td><td align="left" valign="top">Basic setup for obtaining repositories +</td></tr> +<tr><td align="left" valign="top">• <a href="Updating-packages.html">Updating packages</a></td><td> </td><td align="left" valign="top">Update your system </td></tr> -<tr><td align="left" valign="top">• <a href="Chroot.html" accesskey="7">Chroot</a></td><td> </td><td align="left" valign="top">Going inside your new system +<tr><td align="left" valign="top">• <a href="Installing-packages.html">Installing packages</a></td><td> </td><td align="left" valign="top">Install new software on your system </td></tr> -<tr><td align="left" valign="top">• <a href="System-Configuration.html" accesskey="8">System Configuration</a></td><td> </td><td align="left" valign="top">Customizing for your personal use +<tr><td align="left" valign="top">• <a href="Essential-Software.html">Essential Software</a></td><td> </td><td align="left" valign="top">Software you might want to include on your system </td></tr> -<tr><td align="left" valign="top">• <a href="Kernel.html" accesskey="9">Kernel</a></td><td> </td><td align="left" valign="top">Compiling your own kernel +<tr><td align="left" valign="top">• <a href="Obtaining-the-documentation.html">Obtaining the documentation</a></td><td> </td><td align="left" valign="top">Install documentation for offline use (optional) </td></tr> -<tr><td align="left" valign="top">• <a href="Making-your-system-bootable.html">Making your system bootable</a></td><td> </td><td align="left" valign="top">Installing init and bootloader +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +System Configuration + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Configuring-hostname.html">Configuring hostname</a></td><td> </td><td align="left" valign="top">Setting up system hostname (recommended) </td></tr> -<tr><td align="left" valign="top">• <a href="Post_002dinstallation.html">Post-installation</a></td><td> </td><td align="left" valign="top">Acquiring more packages and repositories +<tr><td align="left" valign="top">• <a href="Hosts-file.html">Hosts file</a></td><td> </td><td align="left" valign="top">Setting up hosts file for networking (optional) </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> -Package Manager +Kernel -</pre></th></tr><tr><td align="left" valign="top">• <a href="Usage.html">Usage</a></td><td> </td><td align="left" valign="top">Using Carbs Packaging Tools +</pre></th></tr><tr><td align="left" valign="top">• <a href="Obtaining-the-kernel-sources.html">Obtaining the kernel sources</a></td><td> </td><td align="left" valign="top">Downloading the Linux source code </td></tr> -<tr><td align="left" valign="top">• <a href="Environment-Variables.html">Environment Variables</a></td><td> </td><td align="left" valign="top">Values that affect the operation of CPT +<tr><td align="left" valign="top">• <a href="Kernel-dependencies.html">Kernel dependencies</a></td><td> </td><td align="left" valign="top">Requirements for building the kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Hooks.html">Hooks</a></td><td> </td><td align="left" valign="top">Using hooks to customize the package manager operations +<tr><td align="left" valign="top">• <a href="Building-the-kernel.html">Building the kernel</a></td><td> </td><td align="left" valign="top">Configure and compile the kernel </td></tr> -<tr><td align="left" valign="top">• <a href="Packaging-System.html">Packaging System</a></td><td> </td><td align="left" valign="top">More detail on creating packages +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Making your system bootable + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Bootloader.html">Bootloader</a></td><td> </td><td align="left" valign="top">Install a bootloader for your system </td></tr> -<tr><td align="left" valign="top">• <a href="Rsync-Repositories.html">Rsync Repositories</a></td><td> </td><td align="left" valign="top">Information on using or creating rsync repositories +<tr><td align="left" valign="top">• <a href="Init-scripts.html">Init scripts</a></td><td> </td><td align="left" valign="top">Install init scripts for your system +</td></tr> +<tr><td align="left" valign="top">• <a href="Fstab.html">Fstab</a></td><td> </td><td align="left" valign="top">Generating fstab +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Post-installation + +</pre></th></tr><tr><td align="left" valign="top">• <a href="KISS-repositories.html">KISS repositories</a></td><td> </td><td align="left" valign="top">Acquire kiss repositories </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> @@ -268,15 +234,41 @@ Init System </pre></th></tr><tr><td align="left" valign="top">• <a href="Configuring-Init.html">Configuring Init</a></td><td> </td><td align="left" valign="top">Ways to configure the init system </td></tr> -<tr><td align="left" valign="top">• <a href="Init-Hooks.html">Init Hooks</a></td><td> </td><td align="left" valign="top">Adding your personal commands to the init system +<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replace the default busybox init with something new </td></tr> -<tr><td align="left" valign="top">• <a href="Changing-Init-Program.html">Changing Init Program</a></td><td> </td><td align="left" valign="top">Replacing the default busybox init with something new +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Configuring Init + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Kernel-Command-Line.html">Kernel Command Line</a></td><td> </td><td align="left" valign="top">Configure init through the boot parameters +</td></tr> +<tr><td align="left" valign="top">• <a href="_002fetc_002finit_002frcconf-file.html">‘<samp>/etc/init/rc.conf</samp>’ file</a></td><td> </td><td align="left" valign="top">Configure init through the configuration file +</td></tr> +<tr><td align="left" valign="top">• <a href="Init-Hooks.html">Init Hooks</a></td><td> </td><td align="left" valign="top">Configure init through hooks +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Changing Init Program + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Rebooting-after-changing-init.html">Rebooting after changing init</a></td><td> </td><td align="left" valign="top">Ways to reboot after replacing the init system </td></tr> -</table> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +Contribution Guidelines +</pre></th></tr><tr><td align="left" valign="top">• <a href="Conventions.html">Conventions</a></td><td> </td><td align="left" valign="top">Conventions of the distribution +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +Conventions +</pre></th></tr><tr><td align="left" valign="top">• <a href="Shell-Conventions.html">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts +</td></tr> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr></table> <hr> <div class="header"> diff --git a/src/docs/install.html b/src/docs/install.html new file mode 100644 index 0000000..176aacd --- /dev/null +++ b/src/docs/install.html @@ -0,0 +1,822 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> +<head> +<!-- 2020-12-26 Sat 03:17 --> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<meta name="viewport" content="width=device-width, initial-scale=1" /> +<title>Carbs Linux Installation Guide</title> +<meta name="generator" content="Org mode" /> +<meta name="author" content="Cem Keylan" /> +<style type="text/css"> + <!--/*--><![CDATA[/*><!--*/ + .title { text-align: center; + margin-bottom: .2em; } + .subtitle { text-align: center; + font-size: medium; + font-weight: bold; + margin-top:0; } + .todo { font-family: monospace; color: red; } + .done { font-family: monospace; color: green; } + .priority { font-family: monospace; color: orange; } + .tag { background-color: #eee; font-family: monospace; + padding: 2px; font-size: 80%; font-weight: normal; } + .timestamp { color: #bebebe; } + .timestamp-kwd { color: #5f9ea0; } + .org-right { margin-left: auto; margin-right: 0px; text-align: right; } + .org-left { margin-left: 0px; margin-right: auto; text-align: left; } + .org-center { margin-left: auto; margin-right: auto; text-align: center; } + .underline { text-decoration: underline; } + #postamble p, #preamble p { font-size: 90%; margin: .2em; } + p.verse { margin-left: 3%; } + pre { + border: 1px solid #ccc; + box-shadow: 3px 3px 3px #eee; + padding: 8pt; + font-family: monospace; + overflow: auto; + margin: 1.2em; + } + pre.src { + position: relative; + overflow: visible; + padding-top: 1.2em; + } + pre.src:before { + display: none; + position: absolute; + background-color: white; + top: -10px; + right: 10px; + padding: 3px; + border: 1px solid black; + } + pre.src:hover:before { display: inline;} + /* Languages per Org manual */ + pre.src-asymptote:before { content: 'Asymptote'; } + pre.src-awk:before { content: 'Awk'; } + pre.src-C:before { content: 'C'; } + /* pre.src-C++ doesn't work in CSS */ + pre.src-clojure:before { content: 'Clojure'; } + pre.src-css:before { content: 'CSS'; } + pre.src-D:before { content: 'D'; } + pre.src-ditaa:before { content: 'ditaa'; } + pre.src-dot:before { content: 'Graphviz'; } + pre.src-calc:before { content: 'Emacs Calc'; } + pre.src-emacs-lisp:before { content: 'Emacs Lisp'; } + pre.src-fortran:before { content: 'Fortran'; } + pre.src-gnuplot:before { content: 'gnuplot'; } + pre.src-haskell:before { content: 'Haskell'; } + pre.src-hledger:before { content: 'hledger'; } + pre.src-java:before { content: 'Java'; } + pre.src-js:before { content: 'Javascript'; } + pre.src-latex:before { content: 'LaTeX'; } + pre.src-ledger:before { content: 'Ledger'; } + pre.src-lisp:before { content: 'Lisp'; } + pre.src-lilypond:before { content: 'Lilypond'; } + pre.src-lua:before { content: 'Lua'; } + pre.src-matlab:before { content: 'MATLAB'; } + pre.src-mscgen:before { content: 'Mscgen'; } + pre.src-ocaml:before { content: 'Objective Caml'; } + pre.src-octave:before { content: 'Octave'; } + pre.src-org:before { content: 'Org mode'; } + pre.src-oz:before { content: 'OZ'; } + pre.src-plantuml:before { content: 'Plantuml'; } + pre.src-processing:before { content: 'Processing.js'; } + pre.src-python:before { content: 'Python'; } + pre.src-R:before { content: 'R'; } + pre.src-ruby:before { content: 'Ruby'; } + pre.src-sass:before { content: 'Sass'; } + pre.src-scheme:before { content: 'Scheme'; } + pre.src-screen:before { content: 'Gnu Screen'; } + pre.src-sed:before { content: 'Sed'; } + pre.src-sh:before { content: 'shell'; } + pre.src-sql:before { content: 'SQL'; } + pre.src-sqlite:before { content: 'SQLite'; } + /* additional languages in org.el's org-babel-load-languages alist */ + pre.src-forth:before { content: 'Forth'; } + pre.src-io:before { content: 'IO'; } + pre.src-J:before { content: 'J'; } + pre.src-makefile:before { content: 'Makefile'; } + pre.src-maxima:before { content: 'Maxima'; } + pre.src-perl:before { content: 'Perl'; } + pre.src-picolisp:before { content: 'Pico Lisp'; } + pre.src-scala:before { content: 'Scala'; } + pre.src-shell:before { content: 'Shell Script'; } + pre.src-ebnf2ps:before { content: 'ebfn2ps'; } + /* additional language identifiers per "defun org-babel-execute" + in ob-*.el */ + pre.src-cpp:before { content: 'C++'; } + pre.src-abc:before { content: 'ABC'; } + pre.src-coq:before { content: 'Coq'; } + pre.src-groovy:before { content: 'Groovy'; } + /* additional language identifiers from org-babel-shell-names in + ob-shell.el: ob-shell is the only babel language using a lambda to put + the execution function name together. */ + pre.src-bash:before { content: 'bash'; } + pre.src-csh:before { content: 'csh'; } + pre.src-ash:before { content: 'ash'; } + pre.src-dash:before { content: 'dash'; } + pre.src-ksh:before { content: 'ksh'; } + pre.src-mksh:before { content: 'mksh'; } + pre.src-posh:before { content: 'posh'; } + /* Additional Emacs modes also supported by the LaTeX listings package */ + pre.src-ada:before { content: 'Ada'; } + pre.src-asm:before { content: 'Assembler'; } + pre.src-caml:before { content: 'Caml'; } + pre.src-delphi:before { content: 'Delphi'; } + pre.src-html:before { content: 'HTML'; } + pre.src-idl:before { content: 'IDL'; } + pre.src-mercury:before { content: 'Mercury'; } + pre.src-metapost:before { content: 'MetaPost'; } + pre.src-modula-2:before { content: 'Modula-2'; } + pre.src-pascal:before { content: 'Pascal'; } + pre.src-ps:before { content: 'PostScript'; } + pre.src-prolog:before { content: 'Prolog'; } + pre.src-simula:before { content: 'Simula'; } + pre.src-tcl:before { content: 'tcl'; } + pre.src-tex:before { content: 'TeX'; } + pre.src-plain-tex:before { content: 'Plain TeX'; } + pre.src-verilog:before { content: 'Verilog'; } + pre.src-vhdl:before { content: 'VHDL'; } + pre.src-xml:before { content: 'XML'; } + pre.src-nxml:before { content: 'XML'; } + /* add a generic configuration mode; LaTeX export needs an additional + (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */ + pre.src-conf:before { content: 'Configuration File'; } + + table { border-collapse:collapse; } + caption.t-above { caption-side: top; } + caption.t-bottom { caption-side: bottom; } + td, th { vertical-align:top; } + th.org-right { text-align: center; } + th.org-left { text-align: center; } + th.org-center { text-align: center; } + td.org-right { text-align: right; } + td.org-left { text-align: left; } + td.org-center { text-align: center; } + dt { font-weight: bold; } + .footpara { display: inline; } + .footdef { margin-bottom: 1em; } + .figure { padding: 1em; } + .figure p { text-align: center; } + .equation-container { + display: table; + text-align: center; + width: 100%; + } + .equation { + vertical-align: middle; + } + .equation-label { + display: table-cell; + text-align: right; + vertical-align: middle; + } + .inlinetask { + padding: 10px; + border: 2px solid gray; + margin: 10px; + background: #ffffcc; + } + #org-div-home-and-up + { text-align: right; font-size: 70%; white-space: nowrap; } + textarea { overflow-x: auto; } + .linenr { font-size: smaller } + .code-highlighted { background-color: #ffff00; } + .org-info-js_info-navigation { border-style: none; } + #org-info-js_console-label + { font-size: 10px; font-weight: bold; white-space: nowrap; } + .org-info-js_search-highlight + { background-color: #ffff00; color: #000000; font-weight: bold; } + .org-svg { width: 90%; } + /*]]>*/--> +</style> +</head> +<body> +<div id="content"> +<h1 class="title">Carbs Linux Installation Guide</h1> +<div id="table-of-contents"> +<h2>Table of Contents</h2> +<div id="text-table-of-contents"> +<ul> +<li><a href="#orgf69e554">1. Preparing Environment</a> +<ul> +<li><a href="#org95a0e69">1.1. Download</a></li> +<li><a href="#org8e36ac6">1.2. Signature verification</a></li> +<li><a href="#orgea2754a">1.3. Extracting the tarball</a></li> +<li><a href="#org04cd78e">1.4. Obtain the chroot helper</a></li> +</ul> +</li> +<li><a href="#org75ac2b4">2. Chroot</a> +<ul> +<li><a href="#org8778be8">2.1. Setting up repositories</a> +<ul> +<li><a href="#orga965761">2.1.1. Obtaining from git</a></li> +<li><a href="#orgb7bea54">2.1.2. Obtaining from rsync</a></li> +<li><a href="#orgb72886d">2.1.3. Making the package manager use the repositories</a></li> +</ul> +</li> +<li><a href="#org2a9ee98">2.2. Updating packages</a></li> +<li><a href="#orgf04d2d5">2.3. Installing packages</a></li> +<li><a href="#orgb80a3a8">2.4. Essential Software</a></li> +<li><a href="#org1e0d5e0">2.5. Obtaining the documentation</a></li> +</ul> +</li> +<li><a href="#orgd61a283">3. System Configuration</a> +<ul> +<li><a href="#orgc097724">3.1. Configuring hostname</a></li> +<li><a href="#org88a7ef3">3.2. Hosts file</a></li> +</ul> +</li> +<li><a href="#org92806b4">4. Kernel</a> +<ul> +<li><a href="#orgb246a4d">4.1. Obtaining the kernel sources</a></li> +<li><a href="#orgf9a076f">4.2. Kernel dependencies</a></li> +<li><a href="#orga3c74bc">4.3. Building the kernel</a></li> +</ul> +</li> +<li><a href="#orgb176eb1">5. Making your system bootable</a> +<ul> +<li><a href="#org31a5fde">5.1. Bootloader</a> +<ul> +<li><a href="#org43ed898">5.1.1. GRUB BIOS installation</a></li> +<li><a href="#orgf826efe">5.1.2. GRUB UEFI installation</a></li> +</ul> +</li> +<li><a href="#org2d43b5f">5.2. Init scripts</a></li> +<li><a href="#orgfe8161b">5.3. Fstab</a></li> +</ul> +</li> +<li><a href="#org917e2c8">6. Post-installation</a> +<ul> +<li><a href="#org96641ac">6.1. KISS repositories</a></li> +</ul> +</li> +</ul> +</div> +</div> +<p> +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 +<a href="https://carbslinux.org/docs/install.txt">https://carbslinux.org/docs/install.txt</a>. +</p> + +<div id="outline-container-orgf69e554" class="outline-2"> +<h2 id="orgf69e554"><span class="section-number-2">1</span> Preparing Environment</h2> +<div class="outline-text-2" id="text-1"> +<p> +To install Carbs Linux, you will need a Live Linux ISO. For that purpose, you +can obtain a Gentoo or Void Linux live image. You can follow their instructions +to boot and setup your network. +</p> + +<p> +You will need the following programs in order to install Carbs Linux: +</p> + +<ul class="org-ul"> +<li>tar</li> +<li>wget</li> +<li>xz</li> +<li>some form of base utilities (coreutils, sbase, busybox, etc.)</li> +</ul> + +<p> +Rest of these instructions will assume that you have set all of these up, and +will continue on that point. +</p> +</div> + +<div id="outline-container-org95a0e69" class="outline-3"> +<h3 id="org95a0e69"><span class="section-number-3">1.1</span> Download</h3> +<div class="outline-text-3" id="text-1-1"> +<p> +First, we need to download the rootfs tarball. You can do the following in order +to obtain the rootfs. If you are using an i686 machine, replace the <code>x86_64</code> +with <code>i686</code>. We are setting this in a URL variable so that we don't have to +write it every time. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget $<span style="color: #8e44ad;">URL</span>/carbs-rootfs.tar.xz.sha256 +sha256sum -c carbs-rootfs.tar.xz.sha256 +</pre> +</div> +</div> +</div> + +<div id="outline-container-org8e36ac6" class="outline-3"> +<h3 id="org8e36ac6"><span class="section-number-3">1.2</span> Signature verification</h3> +<div class="outline-text-3" id="text-1-2"> +<p> +It is highly recommended to verify the signature of the tarball. You will need +GPG for this. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget $<span style="color: #8e44ad;">URL</span>/carbs-rootfs.tar.xz.sig +gpg --recv-keys FF484BDFEFCEF8FF +gpg --verify carbs-rootfs.tar.xz.sig +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgea2754a" class="outline-3"> +<h3 id="orgea2754a"><span class="section-number-3">1.3</span> Extracting the tarball</h3> +<div class="outline-text-3" id="text-1-3"> +<p> +You will need to extract the tarball to your desired location. For partitioning, +you can follow <a href="https://wiki.archlinux.org/index.php/Partitioning">this guide</a>. This will assume that you will be mounting your root +partition to <code>/mnt</code>. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">mount /dev/sdx1 /mnt +tar xf carbs-rootfs.tar.xz -C /mnt +</pre> +</div> +</div> +</div> + +<div id="outline-container-org04cd78e" class="outline-3"> +<h3 id="org04cd78e"><span class="section-number-3">1.4</span> Obtain the chroot helper</h3> +<div class="outline-text-3" id="text-1-4"> +<p> +You can obtain the <code>cpt-chroot</code> script in order to do a simple chroot into your +new root filesystem. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://dl.carbslinux.org/distfiles/cpt-chroot +chmod a+x cpt-chroot +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org75ac2b4" class="outline-2"> +<h2 id="org75ac2b4"><span class="section-number-2">2</span> Chroot</h2> +<div class="outline-text-2" id="text-2"> +<p> +Chroot into Carbs Linux! +</p> + +<div class="org-src-container"> +<pre class="src src-sh">./cpt-chroot /mnt +</pre> +</div> +</div> + +<div id="outline-container-org8778be8" class="outline-3"> +<h3 id="org8778be8"><span class="section-number-3">2.1</span> Setting up repositories</h3> +<div class="outline-text-3" id="text-2-1"> +<p> +Newest tarballs do not come with repositories, so you will need to manually +obtain them, and set your <code>CPT_PATH</code> environment variable. Carbs Linux +repositories can either be obtained by <code>git</code> or <code>rsync</code>. While rsync +repositories are overall faster and smaller, git offers the whole history of the +repository and a means to manipulate your repository as you like it. If you want +to obtain the git repository, you will need to install <code>git</code> itself. +</p> + +<p> +The following guide will assume that you put the repositories into <code>~/repos/</code> +directory, but you can put the repositories into any directory you want. So go +ahead and create that directory: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">mkdir -p $<span style="color: #8e44ad;">HOME</span>/repos +</pre> +</div> +</div> + +<div id="outline-container-orga965761" class="outline-4"> +<h4 id="orga965761"><span class="section-number-4">2.1.1</span> Obtaining from git</h4> +<div class="outline-text-4" id="text-2-1-1"> +<p> +Carbs Linux git repositories can be found both from the main server and GitHub +(mirror). Here are both their repository links. You can clone any of them. +</p> + +<ul class="org-ul"> +<li>git://git.carbslinux.org/repository</li> +<li><a href="https://github.com/carbslinux/repository">https://github.com/carbslinux/repository</a></li> +</ul> + +<div class="org-src-container"> +<pre class="src src-sh">git clone git://git.carbslinux.org/repository $<span style="color: #8e44ad;">HOME</span>/repos/carbs +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb7bea54" class="outline-4"> +<h4 id="orgb7bea54"><span class="section-number-4">2.1.2</span> Obtaining from rsync</h4> +<div class="outline-text-4" id="text-2-1-2"> +<p> +Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In +order to obtain it, run the following: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">rsync -avc rsync://carbslinux.org/repo $<span style="color: #8e44ad;">HOME</span>/repos/carbs +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb72886d" class="outline-4"> +<h4 id="orgb72886d"><span class="section-number-4">2.1.3</span> Making the package manager use the repositories</h4> +<div class="outline-text-4" id="text-2-1-3"> +<p> +In your shell's configuration file, or in your <code>~/.profile</code> file, add the +following lines: +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">HOME</span>/repos/carbs/core +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/extra +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/xorg +<span style="color: #8e44ad;">CPT_PATH</span>=$<span style="color: #8e44ad;">CPT_PATH</span>:$<span style="color: #8e44ad;">HOME</span>/repos/carbs/community +<span style="color: #16a085;">export</span> CPT_PATH +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org2a9ee98" class="outline-3"> +<h3 id="org2a9ee98"><span class="section-number-3">2.2</span> Updating packages</h3> +<div class="outline-text-3" id="text-2-2"> +<p> +It is good practice to make sure your system is up to date, especially before +building new packages. If there is an update for the package manager you will +need to update twice. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt-update && cpt-update +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf04d2d5" class="outline-3"> +<h3 id="orgf04d2d5"><span class="section-number-3">2.3</span> Installing packages</h3> +<div class="outline-text-3" id="text-2-3"> +<p> +Since you are operating on a really small base, you might need to build and +install new programs to extend the functionality of your system. In order to +build and install packages new packages in Carbs, you need to execute the +following. "Package" is not actually a package and is given as an example. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt-build package +cpt-install package +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgb80a3a8" class="outline-3"> +<h3 id="orgb80a3a8"><span class="section-number-3">2.4</span> Essential Software</h3> +<div class="outline-text-3" id="text-2-4"> +<p> +Here is a list of software that you might want to have on your system. +</p> + +<p> +<b>BOOTLOADERS</b> +</p> + +<ul class="org-ul"> +<li>efibootmgr</li> +<li>grub</li> +</ul> + +<p> +<b>FILESYSTEMS</b> +</p> + +<ul class="org-ul"> +<li>e2fsprogs</li> +<li>dosfstools</li> +<li>ntfs-3g</li> +</ul> + +<p> +<b>NETWORKING</b> +</p> + +<ul class="org-ul"> +<li>dhcpcd</li> +<li>wpa<sub>supplicant</sub></li> +</ul> + +<p> +<b>TEXT EDITORS</b> +</p> + +<ul class="org-ul"> +<li>nano</li> +<li>vim</li> +<li>neatvi</li> +<li>emacs</li> +<li>emacs-nox (terminal-only version of emacs)</li> +</ul> + +<p> +<b>USER SHELLS</b> +</p> + +<ul class="org-ul"> +<li>bash</li> +<li>zsh</li> +<li>oksh</li> +<li>rc</li> +</ul> + +<p> +<b>POSIX BASE UTILITIES</b> +</p> + +<ul class="org-ul"> +<li>busybox</li> +<li>sbase</li> +<li>coreutils</li> +</ul> + +<p> +<b>DOCUMENTATION</b> +</p> + +<ul class="org-ul"> +<li>carbs-docs</li> +<li>man-pages</li> +<li>man-pages-posix</li> +</ul> +</div> +</div> + +<div id="outline-container-org1e0d5e0" class="outline-3"> +<h3 id="org1e0d5e0"><span class="section-number-3">2.5</span> Obtaining the documentation</h3> +<div class="outline-text-3" id="text-2-5"> +<p> +All the documentation for Carbs Linux can be found on a single info manual to be +viewed offline. You can obtain texinfo or the info (standalone) package in order +to view the documentation. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Install the documentation.</span> +cpt b carbs-docs && cpt i carbs-docs + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Install either texinfo or the info package. We will be installing standalone info</span> +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">as it doesn't need perl.</span> +cpt b info && cpt i info + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">You can then run info and navigate through the documentation.</span> +info carbslinux +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-orgd61a283" class="outline-2"> +<h2 id="orgd61a283"><span class="section-number-2">3</span> System Configuration</h2> +<div class="outline-text-2" id="text-3"> +<p> +After you have finished installing some extra packages, you can configure your +system to your liking. +</p> +</div> + +<div id="outline-container-orgc097724" class="outline-3"> +<h3 id="orgc097724"><span class="section-number-3">3.1</span> Configuring hostname</h3> +<div class="outline-text-3" id="text-3-1"> +<p> +You might want to add a hostname, especially in a networked environment. Your +hostname will default to 'carbslinux' unless you set this. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #16a085;">echo</span> your-hostname > /etc/hostname +</pre> +</div> +</div> +</div> + +<div id="outline-container-org88a7ef3" class="outline-3"> +<h3 id="org88a7ef3"><span class="section-number-3">3.2</span> Hosts file</h3> +<div class="outline-text-3" id="text-3-2"> +<p> +You can edit your /etc/hosts file, which is the static lookup table for host +names. By default, there are two entries for localhost which are OKAY. You can +replace the 'localhost' part of these entries to your hostname. +</p> + +<pre class="example"> +127.0.0.1 localhost.localdomain localhost +::1 localhost.localdomain localhost ip6-localhost +</pre> +</div> +</div> +</div> + +<div id="outline-container-org92806b4" class="outline-2"> +<h2 id="org92806b4"><span class="section-number-2">4</span> Kernel</h2> +<div class="outline-text-2" id="text-4"> +<p> +Kernel isn't managed under the main repositories, even though you could package +one for your personal use. Here is an <a href="https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux">example kernel package</a>, which you will +need to reconfigure for your specific setup if you want to make use of it. +</p> +</div> + +<div id="outline-container-orgb246a4d" class="outline-3"> +<h3 id="orgb246a4d"><span class="section-number-3">4.1</span> Obtaining the kernel sources</h3> +<div class="outline-text-3" id="text-4-1"> +<p> +You can visit the <a href="https://kernel.org">https://kernel.org</a> website to choose a kernel that you want +to install. Though only the latest stable and longterm (LTS) versions are +supported. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Download the kernel and extract it</span> +wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz +tar xf linux-5.9.1.tar.xz + +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">Change directory into the kernel sources</span> +<span style="color: #16a085;">cd</span> linux-5.9.1 +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf9a076f" class="outline-3"> +<h3 id="orgf9a076f"><span class="section-number-3">4.2</span> Kernel dependencies</h3> +<div class="outline-text-3" id="text-4-2"> +<p> +In order to compile the kernel you will need to install some dependencies. You +will need <code>libelf</code> to compile the kernel. If you want to configure using the +menu interface you will also need <code>ncurses</code>. +</p> + +<div class="org-src-container"> +<pre class="src src-sh"><span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">The package manager asks to install if you are building more than one package,</span> +<span style="color: #95a5a6;"># </span><span style="color: #7f8c8d;">so no need to run 'cpt i ...'</span> +cpt b libelf ncurses +</pre> +</div> + +<p> +In the vanilla kernel sources, you need perl to compile the kernel, but it can +be easily patched out. You will need to apply the following patch. Patch was +written by <a href="https://github.com/E5ten">E5ten</a>. You will need to obtain and apply the patch in the kernel +source directory. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch +patch -p1 < kernel-no-perl.patch +</pre> +</div> +</div> +</div> + +<div id="outline-container-orga3c74bc" class="outline-3"> +<h3 id="orga3c74bc"><span class="section-number-3">4.3</span> Building the kernel</h3> +<div class="outline-text-3" id="text-4-3"> +<p> +Next step is configuring and building the kernel. You can check Gentoo's +<a href="https://wiki.gentoo.org/wiki/Kernel/Configuration">kernel configuration guide</a> to learn more about the matter. Overall, Gentoo Wiki +is a good place to learn about configuration according to your hardware. The +following will assume a monolithic kernel. +</p> + +<div class="org-src-container"> +<pre class="src src-sh">make menuconfig +make +install -Dm755 $(make -s image_name) /boot/vmlinuz-linux +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-orgb176eb1" class="outline-2"> +<h2 id="orgb176eb1"><span class="section-number-2">5</span> Making your system bootable</h2> +<div class="outline-text-2" id="text-5"> +<p> +In order to be able to boot your fresh system, wou will need an init-daemon, +init-scripts and a bootloader. The init daemon is already provided by busybox, +but you can optionally change it. +</p> +</div> + +<div id="outline-container-org31a5fde" class="outline-3"> +<h3 id="org31a5fde"><span class="section-number-3">5.1</span> Bootloader</h3> +<div class="outline-text-3" id="text-5-1"> +<p> +In the main repository, there is efibootmgr and grub to serve as bootloaders. +efibootmgr can be used as a standalone bootloader, or can be used to install +grub in a UEFI environment. efibootmgr is needed unless you are using a device +without UEFI support (or you really want to use BIOS for a reason). +</p> +</div> + +<div id="outline-container-org43ed898" class="outline-4"> +<h4 id="org43ed898"><span class="section-number-4">5.1.1</span> GRUB BIOS installation</h4> +<div class="outline-text-4" id="text-5-1-1"> +<div class="org-src-container"> +<pre class="src src-sh">cpt b grub && cpt i grub +grub-install --target=i386-pc /dev/sdX +grub-mkconfig -o /boot/grub/grub.cfg +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgf826efe" class="outline-4"> +<h4 id="orgf826efe"><span class="section-number-4">5.1.2</span> GRUB UEFI installation</h4> +<div class="outline-text-4" id="text-5-1-2"> +<div class="org-src-container"> +<pre class="src src-sh">cpt b efibootmgr && cpt i efibootmgr +cpt b grub && cpt i grub + +grub-install --target=x86_64-efi <span style="color: #0a74b9;">\</span> + --efi-directory=esp <span style="color: #0a74b9;">\</span> + --bootloader-id=CarbsLinux + +grub-mkconfig -o /boot/grub/grub.cfg +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org2d43b5f" class="outline-3"> +<h3 id="org2d43b5f"><span class="section-number-3">5.2</span> Init scripts</h3> +<div class="outline-text-3" id="text-5-2"> +<p> +Only thing left to do is installing the init-scripts, and now you are almost +ready to boot your system! +</p> + +<div class="org-src-container"> +<pre class="src src-sh">cpt b carbs-init && cpt i carbs-init +</pre> +</div> +</div> +</div> + +<div id="outline-container-orgfe8161b" class="outline-3"> +<h3 id="orgfe8161b"><span class="section-number-3">5.3</span> Fstab</h3> +<div class="outline-text-3" id="text-5-3"> +<p> +You can now manually edit your fstab entry, or you can use the genfstab tool. +If you want to use the tool, exit the chroot and run the following: +</p> + +<div class="org-src-container"> +<pre class="src src-sh">wget https://github.com/cemkeylan/genfstab/raw/master/genfstab +chmod +x genfstab +./genfstab -U /mnt >> /mnt/etc/fstab +</pre> +</div> +</div> +</div> +</div> + +<div id="outline-container-org917e2c8" class="outline-2"> +<h2 id="org917e2c8"><span class="section-number-2">6</span> Post-installation</h2> +<div class="outline-text-2" id="text-6"> +<p> +The base installation is now complete, you can now fine tune your system +according to your needs. Rest of these instructions are completely optional. +You can check the rest of the documentation to learn more about the system. +</p> +</div> + +<div id="outline-container-org96641ac" class="outline-3"> +<h3 id="org96641ac"><span class="section-number-3">6.1</span> KISS repositories</h3> +<div class="outline-text-3" id="text-6-1"> +<p> +While not 100% compatible with cpt, you can use kiss repositories in your +system the same way you are using the distribution repositories. Here is an +example for the KISS Linux Community repository. +</p> +</div> +</div> +</div> +</div> +</body> +</html> diff --git a/src/docs/install.txt b/src/docs/install.txt index 50ad008..f7a6881 100644 --- a/src/docs/install.txt +++ b/src/docs/install.txt @@ -1,364 +1,481 @@ -1 Installation -************** + ________________________________ -These are the step-by-step instructions for installing Carbs Linux. + CARBS LINUX INSTALLATION GUIDE -1.1 Preparing Environment -========================= + Cem Keylan + ________________________________ -To install Carbs Linux, you will need a Live Linux ISO. For that -purpose, you can obtain a Gentoo or Void Linux live image. You can -follow their instructions to boot and setup your network. - You will need the following programs in order to install Carbs Linux: +Table of Contents +_________________ - * tar - * wget - * xz - * some form of base utilities (coreutils, sbase, busybox, etc.) +1. Preparing Environment +.. 1. Download +.. 2. Signature verification +.. 3. Extracting the tarball +.. 4. Obtain the chroot helper +2. Chroot +.. 1. Setting up repositories +..... 1. Obtaining from git +..... 2. Obtaining from rsync +..... 3. Making the package manager use the 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 +..... 1. GRUB BIOS installation +..... 2. GRUB UEFI installation +.. 2. Init scripts +.. 3. Fstab +6. Post-installation +.. 1. KISS repositories - Rest of these instructions will assume that you have set all of these -up, and will continue on that point. -1.1.1 Download --------------- +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>. -First, we need to download the rootfs tarball. You can do the following -in order to obtain the rootfs. If you are using an i686 machine, -replace the 'x86_64' with 'i686'. We are setting this in a URL variable -so that we don't have to write it every time. - $ URL=https://dl.carbslinux.org/releases/x86_64 - $ wget $URL/carbs-rootfs.tar.xz +1 Preparing Environment +======================= - We can then check the integrity of the tarball and do a signature -verification. Even thought these are optional, they are highly -recommended. + To install Carbs Linux, you will need a Live Linux ISO. For that + purpose, you can obtain a Gentoo or Void Linux live image. You can + follow their instructions to boot and setup your network. -1.1.2 Check the integrity of the tarball (Recommended) ------------------------------------------------------- + You will need the following programs in order to install Carbs Linux: -All of the releases are saved in a single file named 'sha256sums.txt', -but the latest release is saved on 'carbs-rootfs.tar.xz.sha256'. You -can acquire and verify the tarball. + - tar + - wget + - xz + - some form of base utilities (coreutils, sbase, busybox, etc.) - $ wget $URL/carbs-rootfs.tar.xz.sha256 - $ sha256sum -c carbs-rootfs.tar.xz.sha256 + Rest of these instructions will assume that you have set all of these + up, and will continue on that point. -1.1.3 Verify the signature + +1.1 Download +~~~~~~~~~~~~ + + First, we need to download the rootfs tarball. You can do the + following in order to obtain the rootfs. If you are using an i686 + machine, replace the `x86_64' with `i686'. We are setting this in a + URL variable so that we don't have to write it every time. + + ,---- + | wget $URL/carbs-rootfs.tar.xz.sha256 + | sha256sum -c carbs-rootfs.tar.xz.sha256 + `---- + + +1.2 Signature verification +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + It is highly recommended to verify the signature of the tarball. You + will need GPG for this. + + ,---- + | wget $URL/carbs-rootfs.tar.xz.sig + | gpg --recv-keys FF484BDFEFCEF8FF + | gpg --verify carbs-rootfs.tar.xz.sig + `---- + + +1.3 Extracting the tarball +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You will need to extract the tarball to your desired location. For + partitioning, you can follow [this guide]. This will assume that you + will be mounting your root partition to `/mnt'. + + ,---- + | mount /dev/sdx1 /mnt + | tar xf carbs-rootfs.tar.xz -C /mnt + `---- + + +[this guide] <https://wiki.archlinux.org/index.php/Partitioning> + + +1.4 Obtain the chroot helper +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You can obtain the `cpt-chroot' script in order to do a simple chroot + into your new root filesystem. + + ,---- + | wget https://dl.carbslinux.org/distfiles/cpt-chroot + | chmod a+x cpt-chroot + `---- + + +2 Chroot +======== + + Chroot into Carbs Linux! + + ,---- + | ./cpt-chroot /mnt + `---- + + +2.1 Setting up repositories +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Newest tarballs do not come with repositories, so you will need to + manually obtain them, and set your `CPT_PATH' environment + variable. Carbs Linux repositories can either be obtained by `git' or + `rsync'. While rsync repositories are overall faster and smaller, git + offers the whole history of the repository and a means to manipulate + your repository as you like it. If you want to obtain the git + repository, you will need to install `git' itself. + + The following guide will assume that you put the repositories into + `~/repos/' directory, but you can put the repositories into any + directory you want. So go ahead and create that directory: + + ,---- + | mkdir -p $HOME/repos + `---- + + +2.1.1 Obtaining from git +------------------------ + + Carbs Linux git repositories can be found both from the main server + and GitHub (mirror). Here are both their repository links. You can + clone any of them. + + - git://git.carbslinux.org/repository + - <https://github.com/carbslinux/repository> + + ,---- + | git clone git://git.carbslinux.org/repository $HOME/repos/carbs + `---- + + +2.1.2 Obtaining from rsync -------------------------- -It is highly recommended to verify the signature of the tarball. You -will need GPG for this. + Carbs Linux rsync repositories live in rsync://carbslinux.org/repo. In + order to obtain it, run the following: - $ wget $URL/carbs-rootfs.tar.xz.sig - $ gpg --recv-keys FF484BDFEFCEF8FF - $ gpg --verify carbs-rootfs.tar.xz.sig + ,---- + | rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs + `---- -1.1.4 Extracting the tarball ----------------------------- -You will need to extract the tarball to your desired location. For -partitioning, you can follow this guide -(https://wiki.archlinux.org/index.php/Partitioning). This will assume -that you will be mounting your root partition to '/mnt'. +2.1.3 Making the package manager use the repositories +----------------------------------------------------- - $ mount /dev/sdx1 /mnt - $ tar xf carbs-rootfs.tar.xz -C /mnt + In your shell's configuration file, or in your `~/.profile' file, add + the following lines: -1.1.5 Obtain the chroot helper ------------------------------- + ,---- + | CPT_PATH=$HOME/repos/carbs/core + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg + | CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community + | export CPT_PATH + `---- -You can obtain the 'cpt-chroot' script in order to do a simple chroot -into your new root filesystem. - $ wget https://dl.carbslinux.org/distfiles/cpt-chroot - $ chmod a+x cpt-chroot +2.2 Updating packages +~~~~~~~~~~~~~~~~~~~~~ -1.2 Chroot -========== + It is good practice to make sure your system is up to date, especially + before building new packages. If there is an update for the package + manager you will need to update twice. -Chroot into Carbs Linux! + ,---- + | cpt-update && cpt-update + `---- - $ ./cpt-chroot /mnt -1.2.1 Setting up repositories ------------------------------ +2.3 Installing packages +~~~~~~~~~~~~~~~~~~~~~~~ -Newest tarballs do not come with repositories, so you will need to -manually obtain them, and set your 'CPT_PATH' environment variable. -Carbs Linux repositories can either be obtained by 'git' or 'rsync'. -While rsync repositories are overall faster and smaller, git offers the -whole history of the repository and a means to manipulate your -repository as you like it. If you want to obtain the git repository, -you will need to install 'git' itself. + Since you are operating on a really small base, you might need to + build and install new programs to extend the functionality of your + system. In order to build and install packages new packages in Carbs, + you need to execute the following. "Package" is not actually a package + and is given as an example. - The following guide will assume that you put the repositories into -'~/repos/' directory, but you can put the repositories into any -directory you want. So go ahead and create that directory: + ,---- + | cpt-build package + | cpt-install package + `---- - $ mkdir -p $HOME/repos -1.2.1.1 Obtaining from rsync -............................ +2.4 Essential Software +~~~~~~~~~~~~~~~~~~~~~~ -Carbs Linux rsync repositories live in <rsync://carbslinux.org/repo>. -In order to obtain it, run the following: + Here is a list of software that you might want to have on your system. - $ rsync -avc rsync://carbslinux.org/repo $HOME/repos/carbs + *BOOTLOADERS* -1.2.1.2 Obtaining from git -.......................... + - efibootmgr + - grub -Carbs Linux git repositories can be found both from the main server and -GitHub (mirror). Here are both their repository links. You can clone -any of them. + *FILESYSTEMS* - * <git://git.carbslinux.org/repository> - * <https://github.com/carbslinux/repository> + - e2fsprogs + - dosfstools + - ntfs-3g - $ git clone git://git.carbslinux.org/repository $HOME/repos/carbs + *NETWORKING* -1.2.1.3 Making the package manager use the repositories -....................................................... + - dhcpcd + - wpa_supplicant -In your shell's configuration file, or in your '~/.profile' file, add -the following lines: + *TEXT EDITORS* - export CPT_PATH='' - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/core - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/extra - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/xorg - CPT_PATH=$CPT_PATH:$HOME/repos/carbs/community - export CPT_PATH + - nano + - vim + - neatvi + - emacs + - emacs-nox (terminal-only version of emacs) -1.2.2 Updating packages ------------------------ + *USER SHELLS* -It is good practice to make sure your system is up to date, especially -before building new packages. If there is an update for the package -manager you will need to update twice. + - bash + - zsh + - oksh + - rc - $ cpt update + *POSIX BASE UTILITIES* -1.2.3 Installing packages -------------------------- + - busybox + - sbase + - coreutils -Since you are operating on a really small base, you might need to build -and install new programs to extend the functionality of your system. In -order to build and install packages new packages in Carbs, you need to -execute the following. "Package" is not actually a package and is given -as an example. + *DOCUMENTATION* - $ cpt build package - $ cpt install package + - carbs-docs + - man-pages + - man-pages-posix -1.2.4 Essential Software ------------------------- -Here is a list of software that you might want to have on your system. - - BOOTLOADERS - * efibootmgr - * grub - FILESYSTEMS - * e2fsprogs - * dosfstools - * ntfs-3g - NETWORKING - * dhcpcd - * wpa_supplicant - TEXT EDITORS - * nano - * vim - * neatvi - * nvi - * emacs - * emacs-nox (terminal-only version of emacs) - USER SHELLS - * bash - * zsh - * dash - * oksh - * rc - POSIX BASE UTILITIES - * busybox - * sbase - * coreutils - DOCUMENTATION - * carbs-docs - * man-pages - * man-pages-posix - -1.2.5 Obtaining the documentation (optional) --------------------------------------------- - -All the documentation for Carbs Linux can be found on a single info -manual to be viewed offline. You can obtain texinfo or the info -(standalone) package in order to view the documentation. - - Install the documentation. - $ cpt b carbs-docs && cpt i carbs-docs - - Install either texinfo or the info package. We will be installing standalone info - as it doesn't need perl. - $ cpt b info && cpt i info - - You can then run info and navigate through the documentation. - $ info carbslinux - -1.3 System Configuration -======================== - -After you have finished installing some extra packages, you can -configure your system to your liking. - -1.3.1 Configuring hostname (recommended) ----------------------------------------- - -You might want to add a hostname, especially in a networked environment. -Your hostname will default to 'carbslinux' unless you set this. - - $ echo your-hostname > /etc/hostname - -1.3.2 Setting up hosts file (optional) --------------------------------------- - -You can edit your /etc/hosts file, which is the static lookup table for -host names. By default, there are two entries for localhost which are -OKAY. You can replace the 'localhost' part of these entries to your -hostname. - - 127.0.0.1 localhost.localdomain localhost - ::1 localhost.localdomain localhost ip6-localhost - -1.4 Kernel -========== - -Kernel isn't managed under the main repositories, even though you could -package one for your personal use. Here is an example kernel package -(https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux), -which you will need to reconfigure for your specific setup if you want -to make use of it. - -1.4.1 Obtaining the kernel sources ----------------------------------- - -You can visit the https://kernel.org website to choose a kernel that you -want to install. Though only the latest stable and longterm (LTS) -versions are supported. - - Download the kernel and extract it - $ wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.7.6.tar.xz - $ tar xf linux-5.7.6.tar.xz - - Change directory into the kernel sources - $ cd linux-5.7.6 - -1.4.2 Installing dependencies ------------------------------ - -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'. - - The package manager asks to install if you are building more than one package, - so no need to run 'cpt i ...' - $ cpt b libelf ncurses - - In the vanilla kernel sources, you need perl to compile the kernel, -but it can be easily patched out. You will need to apply the following -patch. Patch was written by E5ten (https://github.com/E5ten). You will -need to obtain and apply the patch in the kernel source directory. - - $ wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch - $ patch -p1 < kernel-no-perl.patch +2.5 Obtaining the documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1.4.3 Compiling the kernel --------------------------- + All the documentation for Carbs Linux can be found on a single info + manual to be viewed offline. You can obtain texinfo or the info + (standalone) package in order to view the documentation. -Next step is configuring and building the kernel. You can check -Gentoo's kernel configuration guide -(https://wiki.gentoo.org/wiki/Kernel/Configuration) to learn more about -the matter. Overall, Gentoo Wiki is a good place to learn about -configuration according to your hardware. The following will assume a -monolithic kernel. + ,---- + | # Install the documentation. + | cpt b carbs-docs && cpt i carbs-docs + | + | # Install either texinfo or the info package. We will be installing standalone info + | # as it doesn't need perl. + | cpt b info && cpt i info + | + | # You can then run info and navigate through the documentation. + | info carbslinux + `---- - $ make menuconfig - $ make - $ install -Dm755 $(make -s image_name) /boot/vmlinuz-linux -1.5 Making your system bootable -=============================== +3 System Configuration +====================== -In order to be able to boot your fresh system, wou will need an -init-daemon, init-scripts and a bootloader. The init daemon is already -provided by busybox, but you can optionally change it. + After you have finished installing some extra packages, you can + configure your system to your liking. -1.5.1 Installing a bootloader ------------------------------ -In the main repository, there is efibootmgr and grub to serve as -bootloaders. efibootmgr can be used as a standalone bootloader, or can -be used to install grub in a UEFI environment. efibootmgr is needed -unless you are using a device without UEFI support (or you really want -to use BIOS for a reason). +3.1 Configuring hostname +~~~~~~~~~~~~~~~~~~~~~~~~ - GRUB BIOS installation + You might want to add a hostname, especially in a networked + environment. Your hostname will default to 'carbslinux' unless you set + this. - $ cpt b grub && cpt i grub - $ grub-install --target=i386-pc /dev/sdX - $ grub-mkconfig -o /boot/grub/grub.cfg + ,---- + | echo your-hostname > /etc/hostname + `---- - GRUB UEFI installation - $ cpt b efibootmgr && cpt i efibootmgr - $ cpt b grub && cpt i grub +3.2 Hosts file +~~~~~~~~~~~~~~ + + You can edit your /etc/hosts file, which is the static lookup table + for host names. By default, there are two entries for localhost which + are OKAY. You can replace the 'localhost' part of these entries to + your hostname. + + ,---- + | 127.0.0.1 localhost.localdomain localhost + | ::1 localhost.localdomain localhost ip6-localhost + `---- + + +4 Kernel +======== + + Kernel isn't managed under the main repositories, even though you + could package one for your personal use. Here is an [example kernel + package], which you will need to reconfigure for your specific setup + if you want to make use of it. + + +[example kernel package] +<https://github.com/cemkeylan/kiss-repository/tree/master/personal/linux> + +4.1 Obtaining the kernel sources +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You can visit the <https://kernel.org> website to choose a kernel that + you want to install. Though only the latest stable and longterm (LTS) + versions are supported. + + ,---- + | # Download the kernel and extract it + | wget https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.9.1.tar.xz + | tar xf linux-5.9.1.tar.xz + | + | # Change directory into the kernel sources + | cd linux-5.9.1 + `---- + + +4.2 Kernel dependencies +~~~~~~~~~~~~~~~~~~~~~~~ + + 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'. + + ,---- + | # The package manager asks to install if you are building more than one package, + | # so no need to run 'cpt i ...' + | cpt b libelf ncurses + `---- + + In the vanilla kernel sources, you need perl to compile the kernel, + but it can be easily patched out. You will need to apply the following + patch. Patch was written by [E5ten]. You will need to obtain and apply + the patch in the kernel source directory. + + ,---- + | wget https://dl.carbslinux.org/distfiles/kernel-no-perl.patch + | patch -p1 < kernel-no-perl.patch + `---- + + +[E5ten] <https://github.com/E5ten> + + +4.3 Building the kernel +~~~~~~~~~~~~~~~~~~~~~~~ + + Next step is configuring and building the kernel. You can check + Gentoo's [kernel configuration guide] to learn more about the + matter. Overall, Gentoo Wiki is a good place to learn about + configuration according to your hardware. The following will assume a + monolithic kernel. + + ,---- + | make menuconfig + | make + | install -Dm755 $(make -s image_name) /boot/vmlinuz-linux + `---- + + +[kernel configuration guide] +<https://wiki.gentoo.org/wiki/Kernel/Configuration> + + +5 Making your system bootable +============================= + + In order to be able to boot your fresh system, wou will need an + init-daemon, init-scripts and a bootloader. The init daemon is already + provided by busybox, but you can optionally change it. + + +5.1 Bootloader +~~~~~~~~~~~~~~ + + In the main repository, there is efibootmgr and grub to serve as + bootloaders. efibootmgr can be used as a standalone bootloader, or + can be used to install grub in a UEFI environment. efibootmgr is + needed unless you are using a device without UEFI support (or you + really want to use BIOS for a reason). + + +5.1.1 GRUB BIOS installation +---------------------------- + + ,---- + | cpt b grub && cpt i grub + | grub-install --target=i386-pc /dev/sdX + | grub-mkconfig -o /boot/grub/grub.cfg + `---- + + +5.1.2 GRUB UEFI installation +---------------------------- - $ grub-install --target=x86_64-efi \ - --efi-directory=esp \ - --bootloader-id=CarbsLinux + ,---- + | cpt b efibootmgr && cpt i efibootmgr + | cpt b grub && cpt i grub + | + | grub-install --target=x86_64-efi \ + | --efi-directory=esp \ + | --bootloader-id=CarbsLinux + | + | grub-mkconfig -o /boot/grub/grub.cfg + `---- - $ grub-mkconfig -o /boot/grub/grub.cfg -1.5.2 Installing init scripts ------------------------------ +5.2 Init scripts +~~~~~~~~~~~~~~~~ -Only thing left to do is installing the init-scripts, and now you are -almost ready to boot your system! + Only thing left to do is installing the init-scripts, and now you are + almost ready to boot your system! - $ cpt b carbs-init && cpt i carbs-init + ,---- + | cpt b carbs-init && cpt i carbs-init + `---- -1.5.3 Generating fstab ----------------------- -You can now manually edit your fstab entry, or you can use the genfstab -tool. If you want to use the tool, exit the chroot and run the -following: +5.3 Fstab +~~~~~~~~~ - $ wget https://github.com/cemkeylan/genfstab/raw/master/genfstab - $ chmod +x genfstab - $ ./genfstab -U /mnt >> /mnt/etc/fstab + You can now manually edit your fstab entry, or you can use the + genfstab tool. If you want to use the tool, exit the chroot and run + the following: -1.6 Post-installation -===================== + ,---- + | wget https://github.com/cemkeylan/genfstab/raw/master/genfstab + | chmod +x genfstab + | ./genfstab -U /mnt >> /mnt/etc/fstab + `---- -The base installation is now complete, you can now fine tune your system -according to your needs. Rest of these instructions are completely -optional. -1.6.1 Acquiring kiss repositories ---------------------------------- +6 Post-installation +=================== -While not 100% compatible with cpt, you can use kiss repositories in -your system the same way you are using the distribution repositories. -Here is an example for the KISS Linux Community repository. + The base installation is now complete, you can now fine tune your + system according to your needs. Rest of these instructions are + completely optional. You can check the rest of the documentation to + learn more about the system. - $ git clone https://github.com/kisslinux/community $HOME/repos/kiss-community - $ export CPT_PATH=$CPT_PATH:$HOME/repos/kiss-community/community - NOTE: There are lots of packages on the KISS community repository -that are also on Carbs Linux main repository. I would advise giving -lower priority to the KISS community repository as it may affect other -packages that you might install. +6.1 KISS repositories +~~~~~~~~~~~~~~~~~~~~~ + While not 100% compatible with cpt, you can use kiss repositories in + your system the same way you are using the distribution + repositories. Here is an example for the KISS Linux Community + repository. diff --git a/src/news.xml b/src/news.xml index 192e4ca..5a1c054 100644 --- a/src/news.xml +++ b/src/news.xml @@ -9,7 +9,7 @@ <description>a simple linux distribution</description> <link>https://carbslinux.org</link> <atom:link href="https://carbslinux.org/news.xml" rel="self" type="application/rss+xml" /> - <lastBuildDate>Thu Dec 10 2020 12:00</lastBuildDate> + <lastBuildDate>Sat Dec 26 2020 00:00</lastBuildDate> <item> <title>Sep 16 2020</title> <pubDate>Wed, 16 Sep 2020</pubDate> diff --git a/src/rss.xml b/src/rss.xml index 6982168..dc8add0 100644 --- a/src/rss.xml +++ b/src/rss.xml @@ -9,7 +9,7 @@ <description>a simple linux distribution</description> <link>https://carbslinux.org</link> <atom:link href="https://carbslinux.org/rss.xml" rel="self" type="application/rss+xml" /> - <lastBuildDate>Thu Dec 10 2020 12:00</lastBuildDate> + <lastBuildDate>Sat Dec 26 2020 00:00</lastBuildDate> <item> <title>First Year of Carbs Linux</title> <pubDate>Thu, 10 Dec 2020</pubDate> diff --git a/templates/template.html b/templates/template.html index 3681825..a75062d 100644 --- a/templates/template.html +++ b/templates/template.html @@ -15,7 +15,7 @@ <a href="//git.carbslinux.org">git</a> <a href='//dl.carbslinux.org'>downloads</a> <a href='/blog'>blog</a> - <a href='/docs/Installation.html'>installation</a> + <a href='/docs/install.html'>installation</a> <a href='/docs'>user manual</a> </nav> </div><div class="border"></div> diff --git a/texidocs b/texidocs -Subproject 3d2fd81bc0f085723f63c8692001c6607d4bbe0 +Subproject d1590234d19724f14e8ba94582986963fce4726 |