update docs

This commit is contained in:
Liam Waldron 2023-05-24 13:19:24 -04:00
parent 3b2ae7342e
commit 2a3bf82243
6 changed files with 142 additions and 6 deletions

View File

@ -60,7 +60,7 @@
<h2>3 - Boot process</h2>
<p><strong>3.1 </strong>Microcode</p>
<p>All users of AMD and Intel CPUs should install their corresponding microcode update package.</p>
<code>(root)# gpkg -f world/{amd,intel}-ucode</code>
<code>(root)# gpkg -f {amd,intel}-ucode</code>
<p><strong>3.2 </strong>Secure boot</p>
<p>Everest does not officially support UEFI secure boot at the moment. While you can always attempt to implement it yourself, there will most likely be pitfalls.</p>
<p>For most users, disabling secure boot altogether is recommended.</p>
@ -76,19 +76,38 @@
<p>AMD graphics drivers are included in distribution kernels, and can be included in custom kernels when configuring. Nouveau, the open source implementation of Nvidia's graphics drivers can be included as well.</p>
<p>While these defaults may be adequate for running a headless machine, or just general web browsing, some users may want more performance out of their GPU.</p>
<p>Install mesa, which provides an open source implementation of OpenGL, Vulkan, and other APIs:</p>
<code>(root)# gpkg -f world/mesa</code>
<code>(root)# gpkg -f mesa</code>
<p>Install AMD drivers:</p>
<code>(root)# gpkg -f world/mesa</code>
<code>(root)# gpkg -f mesa</code>
<p>Install Nvidia drivers on a system running a distribution kernel:</p>
<code>(root)# gpkg -f world/nvidia</code>
<code>(root)# gpkg -f nvidia</code>
<p>Or, install Nvidia drivers on a system running a custom kernel:</p>
<code>(root)# gpkg -f world/nvidia-dkms</code>
<code>(root)# gpkg -f nvidia-dkms</code>
<p><strong>4.3 </strong>Desktop environments</p>
<p>Desktop environments provide a complete graphical interface, like what's found in most Linux distributions. Users who want something that will work out of the box will most likely opt for a desktop environment.</p>
<p>Some popular choices include GNOME, KDE Plasma, and Xfce.</p>
<p><strong>4.4 </strong>Standalone window managers</p>
<p>A window manager is a single program with one task - manage window position, size, etc. Users who want a lightweight, keyboard oriented workflow, and are fine with extensive customization will most likely opt for a window manager.</p>
<p>Some popular choices include i3, sway, bspwm, openbox, awesome, and dwm.</p>
<h2>5 - Networking</h2>
<p><strong>5.1 </strong>Clock synchronization</p>
<p>NTP is a protocol for synchronizing computer clocks over the network.</p>
<p>Chrony, one implementation, is available in the package database.</p>
<p>In case it was not installed, run:</p>
<code>(root)# gpkg -f chrony</code>
<p><Strong>5.2 </strong>Firewall</p>
<p>Firewalls provide an extra layer of protection.</p>
<p>The default firewall in Everest is ufw, which can be installed by running:</p>
<code>(root)# gpkg -f ufw</code>
<h2>6 - Input</h2>
<p><strong>6.1 </strong>Keyboard layouts</p>
<p>If your keyboard layout is non-english, or otherwise unusual, you will need to configure it, both in TTY and in Xorg.</p>
<p>Keymaps are located in /usr/share/kbd/keymaps.</p>
<p>To change the keyboard layout, edit /etc/vconsole.conf:</p>
<fhead><strong>FILE:</strong> /etc/vconsole.conf</fhead>
<div class="file">
<p>KEYMAP=uk</p>
</div>
</div>
<footer>
<p>Page last updated 4/04/23 @ 13:34</p>

View File

@ -49,7 +49,7 @@
<ul id="myUL">
<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="musl-or-glibc.hmtl">musl or glibc?</a></li>
<li><a href="musl-or-glibc.html">musl or glibc?</a></li>
</ul>
</div>
<footer>

View File

@ -46,6 +46,12 @@
<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>
<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>
<p>To merge a package from a repository:</p>

14
docs/mkpage.sh Executable file
View File

@ -0,0 +1,14 @@
#!/bin/sh
usage() {
printf "usage: ${0} NEW_PAGE_NAME\n"
}
if [ "${1}" == "" ]; then
usage "$@"
exit 1
fi
printf "Creating new page...\n"
cp -v template.html ${1}
printf "Done.\n"

83
docs/musl-or-glibc.html Normal file
View 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/everest.css"/>
</head>
<body>
<!-- Navbar -->
<div class="sidenav">
<img src="../img/everest-logo.svg" alt="everest-logo">
<a href="../index.html">Home</a>
<a href="../about.html">About</a>
<a href="../install.html">Install</a>
<a href="https://git.everestlinux.org/EverestLinux/glacier-pkgs">Packages</a>
<a href="../download.html">Downloads</a>
<a href="home.html">Docs</a>
<a href="https://git.everestlinux.org/EverestLinux/wiki">Wiki</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>Musl or Glibc?</h2>
<p>Everest supports 2 different C libraries, musl and glibc. This guide should help you decide which to choose.</p>
<h2>1 - musl</h2>
<p><strong>1.1 </strong>Pros</p>
<p>Musl is extremely lightweight and easy to build, compared to Glibc.</p>
<p>As an added bonus, musl is also more secure than Glibc.</p>
<p>Musl recieves the most support from the Everest development team.</p>
<p><strong>1.2 </strong>Cons</p>
<p>Musl may not support all programs, especially proprietary programs, or programs using Glibc-specific APIs.</p>
<p><strong>1.3 </strong>Who should use musl</p>
<p>Users running a server, doing simple web browsing, or using programs which do not depend on Glibc should use musl.</p>
<p><strong>1.4 </strong>Who shouldn't use musl</p>
<p>Users requiring proprietary software that cannot be patched and recompiled against musl, users who require nvidia graphics drivers, or those who use Steam.</p>
<p>While compatibility layers, such as gcompat, can remedy these issues, there is no 100% perfect solution.</p>
<p><strong>1.5 </strong>Solutions</p>
<p>Those wishing to run musl, even with incompatible software and hardware, have a couple of solutions:</p>
<p><i>1.5.1 </i>gcompat</p>
<p>Gcompat is a shared object file that provides programs with Glibc APIs on a musl system. This can be used for running Glibc programs, but CANNOT be used for compiling them.</p>
<p>Install gcompat by running the following:</p>
<code>(root)# gpkg -f gcompat</code>
<p><i>1.5.2 </i>Glibc chroot</p>
<p>A minimal chroot containing Glibc can be set up very quickly.</p>
<p>First, ensure you have the everest-devtools and everest-buildtools packages installed:</p>
<code>(root)# gpkg -f everest-devtools everest-buildtools</code>
<p>Next, create a directory for the chroot:</p>
<code>(user)$ mkdir your-chroot</code>
<p>Create a filesystem skeleton in the new directory:</p>
<code>(user)$ mkskel -d your-chroot</code>
<p>Install the necessary packages to the chroot:</p>
<warnhead><strong>WARNING:</strong></warnhead>
<div class="warning">
<p>The following command costs a fair amount of disk space. Ensure you have enough free space before proceeding.</p>
<p>Check disk space with the following command:</p>
<code>(root)# df /</code>
</div>
<p><p>
<code>(user)$ mkchroot-glibc -d your-chroot</code>
<p>Finally, use everest-chroot to access the chroot:</p>
<code>(root)# everest-chroot your-chroot</code>
<p>Or, you can manually mount the required filesystems and run:</p>
<code>(root)# chroot --userspec=0:0 your-chroot /bin/sh</code>
<h2>2 - Glibc</h2>
<p><strong>2.1 </strong>Pros</p>
<p>Glibc supports most programs on linux, including proprietary ones.</p>
<p><strong>2.1 </strong>Cons</p>
<p>Glibc is very bloated and heavy on resources for what it does.</p>
</div>
<footer>
<p>Page last updated 5/19/23 @ 14:56</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>

14
mkpage.sh Executable file
View File

@ -0,0 +1,14 @@
#!/bin/sh
usage() {
printf "usage: ${0} NEW_PAGE_NAME\n"
}
if [ "${1}" == "" ]; then
usage "$@"
exit 1
fi
printf "Creating new page...\n"
cp -v template.html ${1}
printf "Done.\n"