archinstall/index.html

189 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>archinstall Documentation &mdash; python-archinstall v2.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=387c4177"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Guided installation" href="installing/guided.html" />
<link href="_static/style.css" rel="stylesheet" type="text/css">
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
python-archinstall
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Running Archinstall</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installing/guided.html">Guided installation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Getting help</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="help/known_issues.html">Known Issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="help/report_bug.html">Report Issues &amp; Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="help/discord.html">Discord</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Archinstall as a library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installing/python.html">Python library</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/python.html">Python module</a></li>
<li class="toctree-l1"><a class="reference internal" href="archinstall/plugins.html">Python Plugins</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="archinstall/Installer.html">archinstall.Installer</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">python-archinstall</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">archinstall Documentation</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="archinstall-documentation">
<h1>archinstall Documentation<a class="headerlink" href="#archinstall-documentation" title="Link to this heading"></a></h1>
<p><strong>archinstall</strong> is a library which can be used to install Arch Linux.
The library comes packaged with different pre-configured installers, such as the default <a class="reference internal" href="installing/guided.html#guided"><span class="std std-ref">Guided installation</span></a> installer.</p>
<p>Some of the features of Archinstall are:</p>
<ul class="simple">
<li><p><strong>Context friendly.</strong> The library always executes calls in sequential order to ensure installation-steps dont overlap or execute in the wrong order. It also supports <em>(and uses)</em> context wrappers to ensure cleanup and final tasks such as <code class="docutils literal notranslate"><span class="pre">mkinitcpio</span></code> are called when needed.</p></li>
<li><p><strong>Full transparency</strong> Logs and insights can be found at <code class="docutils literal notranslate"><span class="pre">/var/log/archinstall</span></code> both in the live ISO and partially on the installed system.</p></li>
<li><p><strong>Accessibility friendly</strong> Archinstall works with <code class="docutils literal notranslate"><span class="pre">espeakup</span></code> and other accessibility tools thanks to the use of a TUI.</p></li>
</ul>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Running Archinstall</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installing/guided.html">Guided installation</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Getting help</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="help/known_issues.html">Known Issues</a><ul>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#waiting-for-time-sync-2144">Waiting for time sync #2144</a></li>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#waiting-for-arch-linux-keyring-sync-archlinux-keyring-wkd-sync-to-complete-2679">Waiting for Arch Linux keyring sync (archlinux-keyring-wkd-sync) to complete. #2679</a></li>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#missing-nvidia-proprietary-driver-2002">Missing Nvidia Proprietary Driver #2002</a></li>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#arm-32bit-and-other-cpu-types-error-out-1686-2185">ARM, 32bit and other CPU types error out #1686, #2185</a></li>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#keyring-is-out-of-date-2213">Keyring is out of date #2213</a></li>
<li class="toctree-l2"><a class="reference internal" href="help/known_issues.html#aur-packages">AUR packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="help/report_bug.html">Report Issues &amp; Bugs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="help/report_bug.html#log-files">Log files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="help/discord.html">Discord</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Archinstall as a library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installing/python.html">Python library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installing/python.html#installing-with-pacman">Installing with pacman</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/python.html#installing-from-pypi">Installing from PyPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/python.html#install-using-source-code">Install using source code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/python.html">Python module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/python.html#pre-requisites">Pre-requisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/python.html#creating-a-script">Creating a script</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="archinstall/plugins.html">Python Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="archinstall/plugins.html#plugin-parameter"><code class="docutils literal notranslate"><span class="pre">--plugin</span></code> parameter</a></li>
<li class="toctree-l2"><a class="reference internal" href="archinstall/plugins.html#plugin-discovery">Plugin Discovery</a></li>
<li class="toctree-l2"><a class="reference internal" href="archinstall/plugins.html#what-s-supported">Whats supported?</a></li>
<li class="toctree-l2"><a class="reference internal" href="archinstall/plugins.html#how-does-it-work">How does it work?</a></li>
<li class="toctree-l2"><a class="reference internal" href="archinstall/plugins.html#writing-your-own">Writing your own?</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="archinstall/Installer.html">archinstall.Installer</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installing/guided.html" class="btn btn-neutral float-right" title="Guided installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Anton Hvornum.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>