12/7/23
This commit is contained in:
@@ -55,6 +55,7 @@
|
||||
<li><a href="dev-docs.html">Developer Documentation</a></li>
|
||||
<li><a href="general-recommendations.html">General Recommendations</a></li>
|
||||
<li><a href="intro-to-glacier.html">Introduction to Glacier</a></li>
|
||||
<li><a href="meta-reading.html">Meta: Reading Guide</a></li>
|
||||
<li><a href="musl-or-glibc.html">musl or glibc?</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -26,15 +26,15 @@
|
||||
<button onclick="window.location.href='home.html';">
|
||||
Back to home
|
||||
</button>
|
||||
<h2>Introduction</h2>
|
||||
<h2>1 - Introduction</h2>
|
||||
<p>Glacier is the package management system for Glacier. All users should be familiar with how it works.</p>
|
||||
<h2>Terminology</h2>
|
||||
<h2>2 - Terminology</h2>
|
||||
<p>In this case, the word 'merge' and 'install' mean the same thing.</p>
|
||||
<p>A package index is a list of all installed packages on any given Everest system.</p>
|
||||
<p>The local index is managed by all users on the system, and is located in /usr/glacier/index.</p>
|
||||
<p>The global index is managed by Git, and is located in /glacier/index.</p>
|
||||
<p>A system profile describes your base system, including C library, architecture, SELinux support, multilib support, etc.</p>
|
||||
<h2>Included programs</h2>
|
||||
<h2>3 - Included programs</h2>
|
||||
<p><strong>3.1 </strong>gpkg</p>
|
||||
<p>'gpkg' is the program most users will be interacting with. It handles the downloading, installation, and logging of packages.</p>
|
||||
<p><strong>3.2 </strong>syspkg</p>
|
||||
@@ -45,30 +45,30 @@
|
||||
<p>'gquery' queries information on a package.</p>
|
||||
<p><strong>3.5 </strong>glacier-mkprofile</p>
|
||||
<p>'glacier-mkprofile' makes changes to the system-wide profile. Users should not interact with this unless needed.</p>
|
||||
<h2>Frontends</h2>
|
||||
<h2>4 - Frontends</h2>
|
||||
<p>Frontends, or wrappers, may provide additional functionality to Glacier.</p>
|
||||
<warnhead><strong>WARNING:</strong></warnhead>
|
||||
<div class="warning">
|
||||
<p>Third party frontends and wrapper scripts are not supported. Use them at your own risk.</p>
|
||||
</div>
|
||||
<h2>Merging packages</h2>
|
||||
<p><strong>4.1 </strong>Using gpkg</p>
|
||||
<h2>5 - Merging packages</h2>
|
||||
<p><strong>5.1 </strong>Using gpkg</p>
|
||||
<p>To merge a package from a repository:</p>
|
||||
<code>(root)# gpkg -f repo/pkg</code>
|
||||
<p>For instance, to install 'vim' in the 'world' repository:</p>
|
||||
<code>(root)# gpkg -f world/vim</code>
|
||||
<p><strong>4.2 </strong>Using syspkg</p>
|
||||
<p><strong>5.2 </strong>Using syspkg</p>
|
||||
<p>Using 'syspkg' is not recommended for end users because all changes to the global package index will be overwritten when pulling a new update.</p>
|
||||
<p>If you understand these risks, and wish to use 'syspkg' anyways, you are acknowledging that things may break.</p>
|
||||
<p>To merge a package from a repository:</p>
|
||||
<code>(root)# syspkg -f repo/pkg</code>
|
||||
<h2>Updating packages</h2>
|
||||
<p><strong>5.1 </strong>Introduction</p>
|
||||
<h2>6 - Updating packages</h2>
|
||||
<p><strong>6.1 </strong>Introduction</p>
|
||||
<p>When merging a package into any index, the package file is retained in said index. This provides most information needed to keep track of the package, however, when updating, an updated package file will need to be downloaded. Old package files will be retained as 'pkgname.old'.</p>
|
||||
<p><strong>5.2 </strong>Using gpkg</p>
|
||||
<p><strong>6.2 </strong>Using gpkg</p>
|
||||
<p>To update a package:</p>
|
||||
<code>(root)# gpkg -u repo/pkg</code>
|
||||
<p><strong>5.3 </strong>Using syspkg</p>
|
||||
<p><strong>6.3 </strong>Using syspkg</p>
|
||||
<p>As mentioned above, 'syspkg' is intended for system development, and NOT for end users.</p>
|
||||
<p>However, 'syspkg -u' has some use cases for end users. These include:</p>
|
||||
<ul>
|
||||
@@ -77,24 +77,24 @@
|
||||
</ul>
|
||||
<p>To update a package:</p>
|
||||
<code>(root)# syspkg -u repo/pkg</code>
|
||||
<h2>Removing packages</h2>
|
||||
<p><strong>6.1 </strong>Introduction</p>
|
||||
<h2>7 - Removing packages</h2>
|
||||
<p><strong>7.1 </strong>Introduction</p>
|
||||
<p>When removing a package, the package info file is moved from the appropriate index to /tmp, and saved as 'pkgname.rm'. This means it will be wiped after the next reboot.</p>
|
||||
<p><strong>6.2 </strong>Using gpkg</p>
|
||||
<p><strong>7.2 </strong>Using gpkg</p>
|
||||
<p>To remove a package:</p>
|
||||
<code>(root)# gpkg -x pkg</code>
|
||||
<p>Note that no repository name was provided. It is not required, as no files will be downloaded during the removal process.</p>
|
||||
<p>If a package is a dependency for another, you will be shown the following error:</p>
|
||||
<code>[x] Could not remove (package_name): is a dependency for (package_name)</code>
|
||||
<p><strong>6.3 </strong>Using syspkg</p>
|
||||
<p><strong>7.3 </strong>Using syspkg</p>
|
||||
<warnhead><strong>WARNING:</strong></warnhead>
|
||||
<div class="warning">
|
||||
<p>Removing packages that shipped with the system images WILL cause catastrophic damage. You have been warned.</p>
|
||||
</div>
|
||||
<p>If you wish to proceed anyways, you can remove a package with:</p>
|
||||
<code>(root)# syspkg -x pkg</code>
|
||||
<h2>Advanced usage</h2>
|
||||
<p><strong>7.1 </strong>Patching packages</p>
|
||||
<h2>8 - Advanced usage</h2>
|
||||
<p><strong>8.1 </strong>Patching packages</p>
|
||||
<p>Patching packages is the act of editing a package file to change compile options, optimizations, etc. It is very useful if used correctly.</p>
|
||||
<p>The officially tested and verified method for patching is as follows:</p>
|
||||
<ul>
|
||||
@@ -102,7 +102,7 @@
|
||||
<li>Edit the package file with a text editor of your choice</li>
|
||||
<li>Install the locally modified package with 'gpkg -fl pkg'</li>
|
||||
</ul>
|
||||
<p><strong>7.2 </strong>Custom package repository</p>
|
||||
<p><strong>8.2 </strong>Custom package repository</p>
|
||||
<p>If Glacier's standard package repository is not sufficient, you can use a custom one.</p>
|
||||
<warnhead><strong>WARNING:</strong></warnhead>
|
||||
<div class="warning">
|
||||
@@ -116,21 +116,21 @@
|
||||
<div class="file">
|
||||
<p>export GREPO="https://some-repo.org</p>
|
||||
</div>
|
||||
<p><strong>7.3 </strong>Compile flags</p>
|
||||
<p><strong>8.3 </strong>Compile flags</p>
|
||||
<p>When an operation is performed on a package, 'gpkg' invokes the system's C compiler, which can take flags for compilation.</p>
|
||||
<p>'MAKEFLAGS', 'CFLAGS', 'CXXFLAGS', and 'LDFLAGS' can be set in '/etc/make.conf'.</p>
|
||||
<p>It is highly recommended to keep '-static' in 'CFLAGS' and 'LDFLAGS'.</p>
|
||||
<p><strong>7.4 </strong>Using syspkg</p>
|
||||
<p><strong>8.4 </strong>Using syspkg</p>
|
||||
<p>'syspkg' is intended for development use and not for end users. That being said, 'syspkg' can be used for fixing security vulnerabilities without pulling in a new release from git.</p>
|
||||
<p>Note that all changes to the global package index ('/glacier/index') will be overwritten during an update, where the user invokes 'git pull' on '/'.</p>
|
||||
<p><strong>7.5 </strong>Whitelisting licenses</p>
|
||||
<p><strong>8.5 </strong>Whitelisting licenses</p>
|
||||
<p>Certain license types can be whitelisted or blacklisted. This is useful for controlling which software is installed on your system.</p>
|
||||
<p>This setting is stored in /etc/glacier.conf, in a simple Bash array. By default, it should look something like this:</p>
|
||||
<fhead><strong>FILE:</strong> /etc/glacier.conf</fhead>
|
||||
<div class="file">
|
||||
<p>export GLACIER_ALLOWED_LICENSES=("GPL v3" "GPL v2" "GPL" "MIT" "BSD" "APACHE")</p>
|
||||
</div>
|
||||
<p><strong>7.6 </strong>Services</p>
|
||||
<p><strong>8.6 </strong>Services</p>
|
||||
<p>Glacier services are small programs that can do certain tasks within Glacier, such as updating the local package database.</p>
|
||||
<p>Services must be enabled in /etc/glacier.conf before they can be used.</p>
|
||||
<fhead><strong>FILE: </strong>/etc/glacier.conf</fhead>
|
||||
@@ -151,25 +151,25 @@
|
||||
<fhead><strong>FILE: </strong>/etc/glacier/end-srv</fhead>
|
||||
<div class="file">
|
||||
<p>#!/bin/bash</p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p>GLACIER_SRV_DIR="/etc/glacier/services"</p>
|
||||
<p>$GLACIER_SRV_DIR/update-pkgdb.hook</p>
|
||||
</div>
|
||||
<h2>Querying packages</h2>
|
||||
<p><strong>8.1 </strong>Introduction</p>
|
||||
<h2>9 - Querying packages</h2>
|
||||
<p><strong>9.1 </strong>Introduction</p>
|
||||
<p>Glacier packages, in ther simplest form, are text files, containing instructions on how the package is built, who made it, what it's called, and what files it includes.</p>
|
||||
<p><strong>8.2 </strong>Querying files</p>
|
||||
<p><strong>9.2 </strong>Querying files</p>
|
||||
<p>All files belonging to a package can be listed with:</p>
|
||||
<code>(user)$ gquery -f pkg</code>
|
||||
<p><strong>8.3 </strong>Querying info</p>
|
||||
<p><strong>9.3 </strong>Querying info</p>
|
||||
<p>Package info can be listed with:</p>
|
||||
<code>(user)$ gquery -i pkg</code>
|
||||
<h2>Writing packages</h2>
|
||||
<p><strong>9.1 </strong>Introduction</p>
|
||||
<h2>10 - Writing packages</h2>
|
||||
<p><strong>10.1 </strong>Introduction</p>
|
||||
<p>As mentioned before, Glacier packages are simply text files. This makes them very easy to write and maintain.</p>
|
||||
<p>If you have previous experience writing PKGBUILDs for the AUR, writing Glacier packages should feel very similar.</p>
|
||||
<p>In this page, 'nano' will be used as an example.</p>
|
||||
<p><strong>9.2 </strong>Metadata</p>
|
||||
<p><strong>10.2 </strong>Metadata</p>
|
||||
<p>Package files start with metadata, which tells Glacier who made the package, what its called, as well as other information.</p>
|
||||
<p>Double check that all of this information is correct before submitting a package.</p>
|
||||
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
|
||||
@@ -184,7 +184,7 @@
|
||||
</div>
|
||||
<p>Hopefully, most of these options are self explanatory.</p>
|
||||
<p>For INCLUDED_FILES, ensure you DON'T include documentation (manpages, etc).</p>
|
||||
<p><strong>9.3 </strong>Integrity information</p>
|
||||
<p><strong>10.3 </strong>Integrity information</p>
|
||||
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
|
||||
<div class="file">
|
||||
<p>SHA256SUMS="86f3442768bd2873cec693f83cdf80b4b444ad3cc14760b74361474fc87a4526"</p>
|
||||
@@ -192,7 +192,7 @@
|
||||
<p>All packages must include their checksums. When merging a package, 'gpkg' will check the provided checksum against the actual checksum of the package, and if they don't match, the operation will be cancelled.</p>
|
||||
<p>To get the checksum of a package:</p>
|
||||
<code>(user)$ sha256sum package</code>
|
||||
<p><strong>9.4 </strong>Dependency information</p>
|
||||
<p><strong>10.4 </strong>Dependency information</p>
|
||||
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
|
||||
<div class="file">
|
||||
<p>DEPENDS=("")</p>
|
||||
@@ -200,7 +200,7 @@
|
||||
</div>
|
||||
<p>Dependency information is extremely important. It allows 'gpkg' to install any dependencies. It also warns the user when a package conflicts with another.</p>
|
||||
<p>This should be fairly easy to figure out. Most projects will have this listed in their README. If you're the developer, you'll probably already know the dependencies your package requires.</p>
|
||||
<p><strong>9.5 </strong>Source information</p>
|
||||
<p><strong>10.5 </strong>Source information</p>
|
||||
<fhead><strong>FILE:</strong> $(pwd)/nano</fhead>
|
||||
<div class="file">
|
||||
<p>PACKAGE_SRC="https://nano-editor.org/dist/v7/nano-7.2.tar.xz</p>
|
||||
|
||||
83
docs/meta-reading.html
Normal file
83
docs/meta-reading.html
Normal file
@@ -0,0 +1,83 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Everest Linux - Docs</title>
|
||||
<link type="text/css" rel="stylesheet" href="../css/nord.css"/>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Navbar -->
|
||||
<div class="sidenav">
|
||||
<img src="../img/everest-nord.svg" alt="everest-logo">
|
||||
<a href="../index.html">Home</a>
|
||||
<a href="../about.html">About</a>
|
||||
<a href="../install.html">Install</a>
|
||||
<a href="../packages.html">Packages</a>
|
||||
<a href="../download.html">Downloads</a>
|
||||
<a href="home.html">Docs</a>
|
||||
<a href="../errata.html">Errata</a>
|
||||
<a href="https://git.everestlinux.org">Git ↗</a>
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="main">
|
||||
<button onclick="window.location.href='home.html';">
|
||||
Back to home
|
||||
</button>
|
||||
<h2>1 - Introduction</h2>
|
||||
<p>Documentation for Everest is formatted in a specific way. This page explains how a page is formatted, and what certain things mean, in as much detail as possible.</p>
|
||||
<h2>2 - Cards</h2>
|
||||
<p><strong>2.1 </strong>Introduction</p>
|
||||
<p>Most Everest documentation pages will contain some type of a "card". Put simply, these are small sections that contain file contents, kernel configurations, warnings, notes, etc. There are 6 types of cards:</p>
|
||||
<p><strong>2.2 </strong>Note</p>
|
||||
<p>This card is the most simple. It contains a note on a certain section. They are usually not required to read, but contain important information.</p>
|
||||
<notehead><strong>NOTE:</strong></notehead>
|
||||
<div class="note">
|
||||
<p>This is an example of a note card.</p>
|
||||
</div>
|
||||
<p><strong>2.3 </strong>Caution</p>
|
||||
<p>This card is one step up from a note. It contains important information, and should be read. However, it usually isn't urgent, or if it is, it contains things that most would consider common knowledge.</p>
|
||||
<cautionhead><strong>CAUTION:</strong></cautionhead>
|
||||
<div class="caution">
|
||||
<p>This is an example of a caution card.</p>
|
||||
</div>
|
||||
<p><strong>2.4 </strong>Warning</p>
|
||||
<p>This card is one of the most important. It contains extremely important information that, if not understood, could lead to system breakage, data loss, etc.</p>
|
||||
<warnhead><strong>WARNING:</strong></warnhead>
|
||||
<div class="warning">
|
||||
<p>This is an example of a warning card.</p>
|
||||
</div>
|
||||
<p><strong>2.5 </strong>File</p>
|
||||
<p>This card contains the contents of a text file. It is usually used to show configuration files.</p>
|
||||
<fhead><strong>FILE:</strong> example.txt</fhead>
|
||||
<div class="file">
|
||||
<p>This is an example of a file card.</p>
|
||||
</div>
|
||||
<p><strong>2.6 </strong>Kernel</p>
|
||||
<p>This card contains a kernel configuration as seen in <cil>make menuconfig</cil>.</p>
|
||||
<khead><strong>KERNEL:</strong> Enable module "example</khead>
|
||||
<div class="kernel">
|
||||
<p>This is an example of a kernel card.</p>
|
||||
</div>
|
||||
<p><strong>2.7 </strong>Bigcode</p>
|
||||
<p>The <cil>code</cil> tag is typically used to denote commands the user should run. The <cil>bigcode</cil> card is meant for showing programs, usually Bash or Python scripts, or C programs.</p>
|
||||
<bigcodehead><strong>CODE:</strong> example.c</bigcodehead>
|
||||
<div class="bigcode">
|
||||
<p>This is an example of a bigcode card.</p>
|
||||
</div>
|
||||
<p><strong>2.8 </strong>News</p>
|
||||
<p>This card is meant for sharing news about the distribution. It is only found on the homepage.</p>
|
||||
<newshead><strong>1/1/70 - Example</strong></newshead>
|
||||
<div class="news">
|
||||
<p>This is an example of a news card.</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<p>Page last updated MM/DD/YY @ HH:MM</p>
|
||||
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
|
||||
<p>--------------------</p>
|
||||
<p>Copyright (C) 2021-2023 Everest Linux</p>
|
||||
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
|
||||
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
|
||||
</footer>
|
||||
62
docs/recovery.html
Normal file
62
docs/recovery.html
Normal file
@@ -0,0 +1,62 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Everest Linux - Docs</title>
|
||||
<link type="text/css" rel="stylesheet" href="../css/nord.css"/>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Navbar -->
|
||||
<div class="sidenav">
|
||||
<img src="../img/everest-nord.svg" alt="everest-logo">
|
||||
<a href="../index.html">Home</a>
|
||||
<a href="../about.html">About</a>
|
||||
<a href="../install.html">Install</a>
|
||||
<a href="../packages.html">Packages</a>
|
||||
<a href="../download.html">Downloads</a>
|
||||
<a href="home.html">Docs</a>
|
||||
<a href="../errata.html">Errata</a>
|
||||
<a href="https://git.everestlinux.org">Git ↗</a>
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="main">
|
||||
<button onclick="window.location.href='home.html';">
|
||||
Back to home
|
||||
</button>
|
||||
<h2>Recovery</h2>
|
||||
<p>System security is very important, however there are time that a system becomes so secure that the owner of the system becomes locked out of their own computer. There are a couple different methods for recovering a locked system.</p>
|
||||
<h2>1 - Issues</h2>
|
||||
<p><strong>1.1</strong> Issues resulting in a locked system</p>
|
||||
<p>There are many things which may lock someone out of their system. The most notable ones are:</p>
|
||||
<ul>
|
||||
<li>Forgotten root password</li>
|
||||
<li>Problematic PAM configuration</li>
|
||||
</ul>
|
||||
<p>There are two methods for recovering a system locked out by these issues, one of which should be set up by default.</p>
|
||||
<h2>2 - Rescue Partition</h2>
|
||||
<p><strong>2.1</strong> Introduction</p>
|
||||
<p>Everest includes a small rescue partition in its system images, which contains only what is necessary to recover a system. Using this partition, system recovery is a relatively easy task.</p>
|
||||
<p><strong>2.2</strong> Booting</p>
|
||||
<p>While installing, either GRUB automatically created a boot entry for the rescue partition, or you did it yourself. If not, the rescue partition is unusable for recovery.</p>
|
||||
<p>To boot into the rescue partition, power off your system, and select <cil>Everest Linux (rescue)</cil> in the GRUB boot menu.</p>
|
||||
<h2>3 - Using BASH as init</h2>
|
||||
<p><strong>3.1</strong> Introduction</p>
|
||||
<p>The Linux kernel supports setting a custom init using kernel parameters. In this instance, we will use <cil>bash</cil> as our init to recover a locked system.</p>
|
||||
<p><strong>3.2</strong> Booting</p>
|
||||
<p>Power off your system. While booting, edit your boot entry's kernel parameters. On GRUB, this can be done with the <cil>e</cil> key.</p>
|
||||
<p>Add the following to your kernel parameters:</p>
|
||||
<khead><strong>KERNEL:</strong> Required kernel parameters to use BASH as init</khead>
|
||||
<div class="kernel">
|
||||
<p>init="/bin/bash"</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<p>Page last updated MM/DD/YY @ HH:MM</p>
|
||||
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
|
||||
<p>--------------------</p>
|
||||
<p>Copyright (C) 2021-2023 Everest Linux</p>
|
||||
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
|
||||
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
|
||||
</footer>
|
||||
Reference in New Issue
Block a user